[Checkins] SVN: Sandbox/ulif/z3c-testsetup/trunk/src/z3c/testsetup/pythontestsetup.txt Fix docs.

Uli Fouquet uli at gnufix.de
Wed Feb 13 06:52:53 EST 2008


Log message for revision 83792:
  Fix docs.

Changed:
  U   Sandbox/ulif/z3c-testsetup/trunk/src/z3c/testsetup/pythontestsetup.txt

-=-
Modified: Sandbox/ulif/z3c-testsetup/trunk/src/z3c/testsetup/pythontestsetup.txt
===================================================================
--- Sandbox/ulif/z3c-testsetup/trunk/src/z3c/testsetup/pythontestsetup.txt	2008-02-13 11:50:11 UTC (rev 83791)
+++ Sandbox/ulif/z3c-testsetup/trunk/src/z3c/testsetup/pythontestsetup.txt	2008-02-13 11:52:53 UTC (rev 83792)
@@ -94,15 +94,27 @@
    that contains no `__init__.py` file). Also subpackages of 'hidden'
    directories are skipped.
 
-4) contain a ReStructured Text meta-marker in the module docstring,
+3) contain a ReStructured Text meta-marker in the module docstring,
    that declares the module as a unittest module explicitly::
 
        :Test-Layer: python
 
    This means: there *must* be a line like the above one in the
-   doctest file. The term might be preceeded or followed by whitspace
-   characters (spaces, tabs).
+   docstring of an accepted module. The term might be preceeded or
+   followed by whitspace characters (spaces, tabs).
 
-Only files, that meet all four conditions are searched for functional
-doctests. You can modify this behaviour of course, which will be
-explained below in detail.
+   The docstring of a module is written at the module header like
+   this:: 
+
+      """
+         This module smashes problems.
+
+         :Test-Layer: python
+
+      """
+      [normal Python code...]
+
+
+Only files, that meet all three conditions are searched for tests.
+You can modify this behaviour of course, which will be explained below
+in detail.



More information about the Checkins mailing list