r13527 - /branches/gui_testing/prompt/doc_string.py -- July 08, 2011 - 11:55

Author: bugman
Date: Fri Jul  8 11:55:31 2011
New Revision: 13527

URL: http://svn.gna.org/viewcvs/relax?rev=13527&view=rev
Log:
Converted the regular expression documentation to the new system.


Modified:
    branches/gui_testing/prompt/doc_string.py

Modified: branches/gui_testing/prompt/doc_string.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/doc_string.py?rev=13527&r1=13526&r2=13527&view=diff
==============================================================================
--- branches/gui_testing/prompt/doc_string.py (original)
+++ branches/gui_testing/prompt/doc_string.py Fri Jul  8 11:55:31 2011
@@ -28,38 +28,25 @@
 class Regexp:
     """Class containing regular expression docstrings."""
 
-    doc = """
+    doc = ["Regular expression", """
+        The python function 'match', which uses regular expression, is used 
to determine which data type to set values to, therefore various data_type 
strings can be used to select the same data type.  Patterns used for matching 
for specific data types are listed below.
 
-        Regular expression
-        ~~~~~~~~~~~~~~~~~~
+        This is a short description of python regular expression, for more 
information see the regular expression syntax section of the Python Library 
Reference.  Some of the regular expression syntax used in this function is:
 
-        The python function 'match', which uses regular expression, is used 
to determine which data
-        type to set values to, therefore various data_type strings can be 
used to select the same
-        data type.  Patterns used for matching for specific data types are 
listed below.
-
-        This is a short description of python regular expression, for more 
information see the
-        regular expression syntax section of the Python Library Reference.  
Some of the regular
-        expression syntax used in this function is:
-
-            '[]':  A sequence or set of characters to match to a single 
character.  For example,
-            '[Ss]2' will match both 'S2' and 's2'.
+            '[]':  A sequence or set of characters to match to a single 
character.  For example, '[sS]2' WILL match both 'S2' and 's2'.
 
             '^':  Match the start of the string.
 
-            '$':  Match the end of the string.  For example, '^[Ss]2$' will 
match 's2' but not 'S2f'
-            or 's2s'.
+            '$':  Match the end of the string.  For example, '^[Ss]2$' will 
match 's2' but not 'S2f' or 's2s'.
 
             '.':  Match any character.
 
-            'x*':  Match the character 'x' any number of times, for example 
'x' will match, as will
-            'xxxxx'
+            'x*':  Match the character 'x' any number of times, for example 
'x' will match, as will 'xxxxx'.
 
             '.*':  Match any sequence of characters of any length.
 
-        Importantly, do not supply a string for the data type containing 
regular expression.  The
-        regular expression is implemented so that various strings can be 
supplied which all match
-        the same data type.
-    """
+        Importantly, do not supply a string for the data type containing 
regular expression.  The regular expression is implemented so that various 
strings can be supplied which all match the same data type.
+    """]
 
 
 class Strings: