r6733 - /branches/rdc_analysis/generic_fns/structure/api_base.py -- July 05, 2008 - 12:17

Author: bugman
Date: Sat Jul  5 12:17:21 2008
New Revision: 6733

URL: http://svn.gna.org/viewcvs/relax?rev=6733&view=rev
Log:
Changed the model arg to struct_index in the structural object API method 
atom_connect().


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

Modified: branches/rdc_analysis/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/rdc_analysis/generic_fns/structure/api_base.py?rev=6733&r1=6732&r2=6733&view=diff
==============================================================================
--- branches/rdc_analysis/generic_fns/structure/api_base.py (original)
+++ branches/rdc_analysis/generic_fns/structure/api_base.py Sat Jul  5 
12:17:21 2008
@@ -86,19 +86,20 @@
         raise RelaxImplementError
 
 
-    def atom_connect(self, index1=None, index2=None, model=None):
+    def atom_connect(self, index1=None, index2=None, struct_index=None):
         """Prototype method stub for connecting two atoms within the data 
structure object.
 
-        This method should connect the atoms corresponding to the two 
indecies.
-
-
-        @keyword index1:    The index of the first atom.
-        @type index1:       int
-        @keyword index2:    The index of the second atom.
-        @type index2:       int
-        @keyword model:     The model to add the atom to.  If not supplied 
and multiple models
-                            exist, then the atom will be added to all models.
-        @type model:        None or int
+        This method should connect the atoms corresponding to the indecies.
+
+
+        @keyword index1:        The index of the first atom.
+        @type index1:           int
+        @keyword index2:        The index of the second atom.
+        @type index2:           int
+        @keyword struct_index:  The index of the structure to connect the 
atoms of.  If not supplied
+                                and multiple structures or models are 
loaded, then the atoms will be
+                                connected within all structures.
+        @type struct_index:     None or int
         """
 
         # Raise the error.