r5533 - /1.3/generic_fns/sequence.py -- April 10, 2008 - 11:53

Author: bugman
Date: Thu Apr 10 11:53:53 2008
New Revision: 5533

URL: http://svn.gna.org/viewcvs/relax?rev=5533&view=rev
Log:
Epydoc fixes in the docstrings of write_body() and write_header().


Modified:
    1.3/generic_fns/sequence.py

Modified: 1.3/generic_fns/sequence.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/sequence.py?rev=5533&r1=5532&r2=5533&view=diff
==============================================================================
--- 1.3/generic_fns/sequence.py (original)
+++ 1.3/generic_fns/sequence.py Thu Apr 10 11:53:53 2008
@@ -280,20 +280,24 @@
 def write_body(file=None, sep=None, mol_name_flag=True, res_num_flag=True, 
res_name_flag=True, spin_num_flag=True, spin_name_flag=True):
     """Function for writing to the given file object the molecule, residue, 
and/or sequence data.
 
-    @param file:            The file object to write the data to.
-    @type file:             file object
-    @param sep:             The column seperator which, if None, defaults to 
whitespace.
-    @type sep:              str or None
-    @param mol_name_flag:   A flag which if True will cause the molecule 
name column to be written.
-    @type mol_name_flag:    bool
-    @param res_num_flag:    A flag which if True will cause the residue 
number column to be written.
-    @type res_num_flag:     bool
-    @param res_name_flag:   A flag which if True will cause the residue name 
column to be written.
-    @type res_name_flag:    bool
-    @param spin_name_flag:  A flag which if True will cause the spin name 
column to be written.
-    @type spin_name_flag:   bool
-    @param spin_num_flag:   A flag which if True will cause the spin number 
column to be written.
-    @type spin_num_flag:    bool
+    @param file:                The file to write the data to.
+    @type file:                 writable file object
+    @keyword sep:               The column seperator which, if None, 
defaults to whitespace.
+    @type sep:                  str or None
+    @keyword mol_name_flag:     A flag which if True will cause the molecule 
name column to be
+                                written.
+    @type mol_name_flag:        bool
+    @keyword res_num_flag:      A flag which if True will cause the residue 
number column to be
+                                written.
+    @type res_num_flag:         bool
+    @keyword res_name_flag:     A flag which if True will cause the residue 
name column to be
+                                written.
+    @type res_name_flag:        bool
+    @keyword spin_name_flag:    A flag which if True will cause the spin 
name column to be written.
+    @type spin_name_flag:       bool
+    @keyword spin_num_flag:     A flag which if True will cause the spin 
number column to be
+                                written.
+    @type spin_num_flag:        bool
     """
 
     # No special seperator character.
@@ -321,20 +325,24 @@
 def write_header(file, sep=None, mol_name_flag=True, res_num_flag=True, 
res_name_flag=True, spin_num_flag=True, spin_name_flag=True):
     """Function for writing to the given file object the molecule, residue, 
and/or sequence data.
 
-    @param file:            The file to write the data to.
-    @type file:             writable file object
-    @param sep:             The column seperator which, if None, defaults to 
whitespace.
-    @type sep:              str or None
-    @param mol_name_flag:   A flag which if True will cause the molecule 
name column to be written.
-    @type mol_name_flag:    bool
-    @param res_num_flag:    A flag which if True will cause the residue 
number column to be written.
-    @type res_num_flag:     bool
-    @param res_name_flag:   A flag which if True will cause the residue name 
column to be written.
-    @type res_name_flag:    bool
-    @param spin_name_flag:  A flag which if True will cause the spin name 
column to be written.
-    @type spin_name_flag:   bool
-    @param spin_num_flag:   A flag which if True will cause the spin number 
column to be written.
-    @type spin_num_flag:    bool
+    @param file:                The file to write the data to.
+    @type file:                 writable file object
+    @keyword sep:               The column seperator which, if None, 
defaults to whitespace.
+    @type sep:                  str or None
+    @keyword mol_name_flag:     A flag which if True will cause the molecule 
name column to be
+                                written.
+    @type mol_name_flag:        bool
+    @keyword res_num_flag:      A flag which if True will cause the residue 
number column to be
+                                written.
+    @type res_num_flag:         bool
+    @keyword res_name_flag:     A flag which if True will cause the residue 
name column to be
+                                written.
+    @type res_name_flag:        bool
+    @keyword spin_name_flag:    A flag which if True will cause the spin 
name column to be written.
+    @type spin_name_flag:       bool
+    @keyword spin_num_flag:     A flag which if True will cause the spin 
number column to be
+                                written.
+    @type spin_num_flag:        bool
     """
 
     # No special seperator character.