[Checkins] SVN: z3c.testsetup/branches/new_markers/src/z3c/testsetup/unittestsetup.txt Update docs.

Uli Fouquet uli at gnufix.de
Wed Jan 7 09:44:41 EST 2009


Log message for revision 94580:
  Update docs.

Changed:
  U   z3c.testsetup/branches/new_markers/src/z3c/testsetup/unittestsetup.txt

-=-
Modified: z3c.testsetup/branches/new_markers/src/z3c/testsetup/unittestsetup.txt
===================================================================
--- z3c.testsetup/branches/new_markers/src/z3c/testsetup/unittestsetup.txt	2009-01-07 13:55:44 UTC (rev 94579)
+++ z3c.testsetup/branches/new_markers/src/z3c/testsetup/unittestsetup.txt	2009-01-07 14:44:41 UTC (rev 94580)
@@ -105,19 +105,24 @@
    that defines the module as a testing module
    explicitly::
 
-       :Test-Layer: python
+       :unittest:
 
    This means: there *must* be a line like the above one in the
    docstring of the module (not: docstring of a class or function
    therein). The term might be preceeded or followed by whitspace
    characters (spaces, tabs).
 
+   .. note:: What about ``:Test-Layer: python``?
+
+      This marker was used in former releases of ``z3c.testsetup``. It
+      currently still works but is deprecated now.
+
    For example a module `example.py` would be found if it contains::
 
       """
       Tests to foo.
 
-      :Test-Layer: python
+      :unittest:
       """
       import unittest
 
@@ -145,16 +150,8 @@
 The unit test setup requires that files contain the above mentioned
 ReStructured Text meta-marker::
 
-    `:Test-Layer: unit`
+    `:unittest:`
 
-in their module docstring. This is determined by a list of regular
-expressions, which is also available as an object attribute::
-
-    >>> setup.regexp_list
-    ['^/s*:(T|t)est-(L|l)ayer:/s*(python)/s*']
-
-This is the default value of unit test setups.
-
 There is one file in the `cave` subpackage, which includes that
 marker. We can get the list of test files using
 `getTestFiles()``::



More information about the Checkins mailing list