r8597 - /branches/multi_structure/generic_fns/structure/api_base.py -- January 22, 2009 - 16:05

Author: bugman
Date: Thu Jan 22 16:05:50 2009
New Revision: 8597

URL: http://svn.gna.org/viewcvs/relax?rev=8597&view=rev
Log:
Renamed the struct_index arg to model_num in write_pdb().


Modified:
    branches/multi_structure/generic_fns/structure/api_base.py

Modified: branches/multi_structure/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/multi_structure/generic_fns/structure/api_base.py?rev=8597&r1=8596&r2=8597&view=diff
==============================================================================
--- branches/multi_structure/generic_fns/structure/api_base.py (original)
+++ branches/multi_structure/generic_fns/structure/api_base.py Thu Jan 22 
16:05:50 2009
@@ -450,7 +450,7 @@
             self.structural_data.to_xml(doc, str_element)
 
 
-    def write_pdb(self, file, struct_index=None):
+    def write_pdb(self, file, model_num=None):
         """Prototype method stub for the creation of a PDB file from the 
structural data.
 
         The PDB records
@@ -692,9 +692,9 @@
 
         @param file:            The PDB file object.  This object must be 
writable.
         @type file:             file object
-        @param struct_index:    The index of the structural container to 
write.  If None, all
-                                structures will be written.
-        @type struct_index:     int
+        @keyword model_num:     The model to place into the PDB file.  If 
not supplied, then all
+                                models will be placed into the file.
+        @type model_num:        None or int
         """
 
         # Raise the error.