r6165 - /1.3/generic_fns/structure/api_base.py -- May 20, 2008 - 16:07

Author: bugman
Date: Tue May 20 16:06:58 2008
New Revision: 6165

URL: http://svn.gna.org/viewcvs/relax?rev=6165&view=rev
Log:
Updated the load_pdb() docstring to be specific to PDB files.


Modified:
    1.3/generic_fns/structure/api_base.py

Modified: 1.3/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/api_base.py?rev=6165&r1=6164&r2=6165&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Tue May 20 16:06:58 2008
@@ -185,13 +185,13 @@
 
 
     def load_pdb(self, file_path, model=None, verbosity=False):
-        """Prototype method stub for loading structures from a file.
+        """Prototype method stub for loading structures from a PDB file.
 
         This inherited prototype method is a stub which, if the 
functionality is desired, should be
         overwritten by the derived class.
 
 
-        @param file_path:   The full path of the file.
+        @param file_path:   The full path of the PDB file.
         @type file_path:    str
         @param model:       The structural model to use.
         @type model:        int