r9319 - /1.3/prompt/doc_string.py -- August 14, 2009 - 17:54

Author: bugman
Date: Fri Aug 14 17:54:39 2009
New Revision: 9319

URL: http://svn.gna.org/viewcvs/relax?rev=9319&view=rev
Log:
Converted the function into a class object variable.


Modified:
    1.3/prompt/doc_string.py

Modified: 1.3/prompt/doc_string.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/doc_string.py?rev=9319&r1=9318&r2=9319&view=diff
==============================================================================
--- 1.3/prompt/doc_string.py (original)
+++ 1.3/prompt/doc_string.py Fri Aug 14 17:54:39 2009
@@ -1,6 +1,6 @@
 
###############################################################################
 #                                                                            
 #
-# Copyright (C) 2005 Edward d'Auvergne                                       
 #
+# Copyright (C) 2005, 2009 Edward d'Auvergne                                 
 #
 #                                                                            
 #
 # This file is part of the program relax.                                    
 #
 #                                                                            
 #
@@ -20,9 +20,13 @@
 #                                                                            
 #
 
###############################################################################
 
+# Module docstring.
+"""Module containing various shared docstrings."""
+__docformat__ = 'plaintext'
 
-def regexp_doc():
-    """Function for returning the docstring for regular expression."""
+
+class Regexp:
+    """Class containing regular expression docstrings."""
 
     doc = """
 
@@ -57,4 +61,16 @@
         the same data type.
     """
 
-    return doc
+
+class Strings:
+    """The docstring object containing class containers of docstrings."""
+
+    def __init__(self):
+        """Initialise docstring object."""
+
+        # The regular expression.
+        self.regexp = Regexp()
+
+
+# The object.
+docs = Strings()