r13380 - /branches/gui_testing/prompt/structure.py -- July 01, 2011 - 17:06

Author: bugman
Date: Fri Jul  1 17:06:03 2011
New Revision: 13380

URL: http://svn.gna.org/viewcvs/relax?rev=13380&view=rev
Log:
The structure.delete() user function now uses _build_doc() for its docstring.


Modified:
    branches/gui_testing/prompt/structure.py

Modified: branches/gui_testing/prompt/structure.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/structure.py?rev=13380&r1=13379&r2=13380&view=diff
==============================================================================
--- branches/gui_testing/prompt/structure.py (original)
+++ branches/gui_testing/prompt/structure.py Fri Jul  1 17:06:03 2011
@@ -251,30 +251,25 @@
 
 
     def delete(self):
-        """Delete all structural information from the current data pipe.
-
-        Description
-        ~~~~~~~~~~~
-
+        # Function intro text.
+        if self._exec_info.intro:
+            text = self._exec_info.ps3 + "structure.delete()"
+            print(text)
+
+        # Execute the functional code.
+        generic_fns.structure.main.delete()
+
+    # The function doc info.
+    delete._doc_title = "Delete all structural information from the current 
data pipe."
+    delete._doc_desc = """
         This function will delete all the structural information.
-
-
-        Example
-        ~~~~~~~
-
+        """
+    delete._doc_examples = """
         Simply type:
 
         relax> structure.delete()
-
-        """
-
-        # Function intro text.
-        if self._exec_info.intro:
-            text = self._exec_info.ps3 + "structure.delete()"
-            print(text)
-
-        # Execute the functional code.
-        generic_fns.structure.main.delete()
+        """
+    _build_doc(delete)
 
 
     def load_spins(self, spin_id=None, combine_models=True, ave_pos=True):