Author: bugman
Date: Tue Oct 7 00:22:39 2008
New Revision: 7545
URL: http://svn.gna.org/viewcvs/relax?rev=7545&view=rev
Log:
Many epydoc docstring fixes.
Modified:
1.3/generic_fns/pymol.py
1.3/generic_fns/structure/geometric.py
1.3/generic_fns/structure/internal.py
1.3/generic_fns/structure/scientific.py
Modified: 1.3/generic_fns/pymol.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pymol.py?rev=7545&r1=7544&r2=7545&view=diff
==============================================================================
--- 1.3/generic_fns/pymol.py (original)
+++ 1.3/generic_fns/pymol.py Tue Oct 7 00:22:39 2008
@@ -376,7 +376,7 @@
def vector_dist(file=None):
"""Display the XH bond vector distribution.
- @keword file: The vector distribution PDB file.
+ @keyword file: The vector distribution PDB file.
@type file: str
"""
Modified: 1.3/generic_fns/structure/geometric.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/geometric.py?rev=7545&r1=7544&r2=7545&view=diff
==============================================================================
--- 1.3/generic_fns/structure/geometric.py (original)
+++ 1.3/generic_fns/structure/geometric.py Tue Oct 7 00:22:39 2008
@@ -666,25 +666,31 @@
This function returns an array of unit vectors uniformly distributed
within 3D space. To
create the distribution, uniform spherical angles are used. The two
spherical angles are
- defined as
+ defined as::
theta = 2.pi.u,
phi = cos^-1(2v - 1),
- where
+ where::
u in [0, 1),
v in [0, 1].
Because theta is defined between [0, pi] and phi is defined between [0,
2pi], for a uniform
distribution u is only incremented half of 'inc'. The unit vectors are
generated using the
- equation
+ equation::
| cos(theta) * sin(phi) |
vector = | sin(theta) * sin(phi) |.
| cos(phi) |
The vectors of this distribution generate both longitudinal and
latitudinal lines.
+
+
+ @keyword inc: The number of increments in the distribution.
+ @type inc: int
+ @return: The distribution of vectors on a sphere.
+ @rtype: list of rank-1, 3D numpy arrays
"""
# The inc argument must be an even number.
Modified: 1.3/generic_fns/structure/internal.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/internal.py?rev=7545&r1=7544&r2=7545&view=diff
==============================================================================
--- 1.3/generic_fns/structure/internal.py (original)
+++ 1.3/generic_fns/structure/internal.py Tue Oct 7 00:22:39 2008
@@ -273,10 +273,10 @@
For any other residues, no description is returned.
- @param res: The residue ID.
- @type res: str
- @return: The chemical name.
- @rtype: str or None
+ @param hetID: The residue ID.
+ @type hetID: str
+ @return: The chemical name.
+ @rtype: str or None
"""
# Tensor.
Modified: 1.3/generic_fns/structure/scientific.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/scientific.py?rev=7545&r1=7544&r2=7545&view=diff
==============================================================================
--- 1.3/generic_fns/structure/scientific.py (original)
+++ 1.3/generic_fns/structure/scientific.py Tue Oct 7 00:22:39 2008
@@ -298,7 +298,6 @@
average atom properties across all
loaded structures.
@type ave: bool
@return: A tuple of atomic information, as
described in the docstring.
- @return: A tuple of atomic information, as
described in the docstring.
@rtype: tuple consisting of optional molecule
name (str), residue number
(int), residue name (str), atom number
(int), atom name(str),
element name (str), and atomic position
(array of len 3).
r7545 - in /1.3/generic_fns: pymol.py structure/geometric.py structure/internal.py structure/scientific.py