r18850 - /trunk/generic_fns/structure/main.py -- March 18, 2013 - 13:42

Author: bugman
Date: Mon Mar 18 13:42:16 2013
New Revision: 18850

URL: http://svn.gna.org/viewcvs/relax?rev=18850&view=rev
Log:
Docstring fix for the structure.read_pdb user function backend.


Modified:
    trunk/generic_fns/structure/main.py

Modified: trunk/generic_fns/structure/main.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/generic_fns/structure/main.py?rev=18850&r1=18849&r2=18850&view=diff
==============================================================================
--- trunk/generic_fns/structure/main.py (original)
+++ trunk/generic_fns/structure/main.py Mon Mar 18 13:42:16 2013
@@ -513,14 +513,14 @@
     @type set_model_num:    None, int, or list of int
     @keyword parser:        The parser to be used to read the PDB file.
     @type parser:           str
-    @keyword fail:          A flag which, if True, will cause a RelaxError 
to be raised if the PDB file does not exist.  If False, then a RelaxWarning 
will be trown instead.
-    @type fail:             bool
     @keyword alt_loc:       The PDB ATOM record 'Alternate location 
indicator' field value to select which coordinates to use.
     @type alt_loc:          str or None
     @keyword verbosity:     The amount of information to print to screen.  
Zero corresponds to minimal output while higher values increase the amount of 
output.  The default value is 1.
     @type verbosity:        int
     @keyword merge:         A flag which if set to True will try to merge 
the PDB structure into the currently loaded structures.
     @type merge:            bool
+    @keyword fail:          A flag which, if True, will cause a RelaxError 
to be raised if the PDB file does not exist.  If False, then a RelaxWarning 
will be trown instead.
+    @type fail:             bool
     @raise RelaxFileError:  If the fail flag is set, then a RelaxError is 
raised if the PDB file does not exist.
     """