Author: bugman
Date: Thu Dec 11 11:42:40 2014
New Revision: 27085
URL: http://svn.gna.org/viewcvs/relax?rev=27085&view=rev
Log:
Documentation fix for the assemble_coord_array() function.
The return values for lib.structure.internal.coordinates.assemble_coord_array()
were incorrectly
documented.
Modified:
trunk/lib/structure/internal/coordinates.py
Modified: trunk/lib/structure/internal/coordinates.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/lib/structure/internal/coordinates.py?rev=27085&r1=27084&r2=27085&view=diff
==============================================================================
--- trunk/lib/structure/internal/coordinates.py (original)
+++ trunk/lib/structure/internal/coordinates.py Thu Dec 11 11:42:40 2014
@@ -39,8 +39,8 @@
@type molecules: None or list of lists of str
@keyword atom_id: The molecule, residue, and atom identifier string
of the coordinates of interest. This matches the spin ID string format.
@type atom_id: None or str
- @return: The array of atomic coordinates (first dimension
is the model and/or molecule, the second are the atoms, and the third are the
coordinates); a list of unique IDs for each structural object, model, and
molecule; the list of element names for each atom (if the elements flag is set).
- @rtype: numpy rank-3 float64 array, list of str, list of
str
+ @return: The array of atomic coordinates (first dimension
is the model and/or molecule, the second are the atoms, and the third are the
coordinates); a list of unique IDs for each structural object, model, and
molecule; the list of element names for each structural object and each atom
(if the elements flag is set).
+ @rtype: numpy rank-3 float64 array, list of str, list of
list of str
"""
# Assemble the atomic coordinates of all structures.
_______________________________________________
relax (http://www.nmr-relax.com)
This is the relax-commits mailing list
[email protected]
To unsubscribe from this list, get a password
reminder, or change your subscription options,
visit the list information page at
https://mail.gna.org/listinfo/relax-commits
