Author: bugman
Date: Tue Jun 15 16:51:24 2010
New Revision: 11243
URL: http://svn.gna.org/viewcvs/relax?rev=11243&view=rev
Log:
Some function/method docstring epydoc formatting fixes.
Modified:
1.3/generic_fns/structure/geometric.py
1.3/info.py
1.3/maths_fns/n_state_model.py
1.3/maths_fns/rotation_matrix.py
Modified: 1.3/generic_fns/structure/geometric.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/geometric.py?rev=11243&r1=11242&r2=11243&view=diff
==============================================================================
--- 1.3/generic_fns/structure/geometric.py (original)
+++ 1.3/generic_fns/structure/geometric.py Tue Jun 15 16:51:24 2010
@@ -925,7 +925,6 @@
@type cone: class instance
@keyword chain_id: The chain identifier.
@type chain_id: str
- @type limit_check: function
@keyword dome_start: The starting atom number of the cone dome
residue.
@type dome_start: int
@keyword edge_start: The starting atom number of the cone edge
residue.
Modified: 1.3/info.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/info.py?rev=11243&r1=11242&r2=11243&view=diff
==============================================================================
--- 1.3/info.py (original)
+++ 1.3/info.py Tue Jun 15 16:51:24 2010
@@ -403,11 +403,11 @@
This is only called for objects not found in the class.
- @param name: The name of the object.
- @type name: str
- @raises: AttributeError if the object cannot be created.
- @returns: The generated object.
- @rtype: anything
+ @param name: The name of the object.
+ @type name: str
+ @raises AttributeError: If the object cannot be created.
+ @returns: The generated object.
+ @rtype: anything
"""
# Page numbers.
@@ -435,9 +435,12 @@
def cite_short(self, author=True, title=True, journal=True, volume=True,
number=True, pages=True, year=True, doi=True, url=True):
- """Compile a short citation in the form of:
-
- d'Auvergne, E.J. and Gooley, P.R. (2008). Optimisation of NMR
dynamic models I. Minimisation algorithms and their performance within the
model-free and Brownian rotational diffusion spaces. J. Biomol. NMR, 40(2),
107-119.
+ """Compile a short citation.
+
+ The returned text will have the form of:
+
+ - d'Auvergne, E.J. and Gooley, P.R. (2008). Optimisation of NMR
dynamic models I. Minimisation algorithms and their performance within the
model-free and Brownian rotational diffusion spaces. J. Biomol. NMR, 40(2),
107-119.
+
@keyword author: The author flag.
@type author: bool
Modified: 1.3/maths_fns/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/maths_fns/n_state_model.py?rev=11243&r1=11242&r2=11243&view=diff
==============================================================================
--- 1.3/maths_fns/n_state_model.py (original)
+++ 1.3/maths_fns/n_state_model.py Tue Jun 15 16:51:24 2010
@@ -1221,7 +1221,7 @@
pc-Anm second partial derivatives
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The probability parameter-tensor element second partial derivative
is::
@@ -1254,7 +1254,7 @@
pc-Anm second partial derivatives
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The probability parameter-tensor element second partial derivative
is::
Modified: 1.3/maths_fns/rotation_matrix.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/maths_fns/rotation_matrix.py?rev=11243&r1=11242&r2=11243&view=diff
==============================================================================
--- 1.3/maths_fns/rotation_matrix.py (original)
+++ 1.3/maths_fns/rotation_matrix.py Tue Jun 15 16:51:24 2010
@@ -1832,9 +1832,7 @@
def R_to_tilt_torsion(R):
"""Convert the rotation matrix to the tilt and torsion rotation angles.
- This notation is taken from:
-
- Bonev, I. A. and Gosselin, C. M. (2006) Analytical determination of
the workspace of symmetrical spherical parallel mechanisms. IEEE
Transactions on Robotics, 22(5), 1011-1017.
+ This notation is taken from "Bonev, I. A. and Gosselin, C. M. (2006)
Analytical determination of the workspace of symmetrical spherical parallel
mechanisms. IEEE Transactions on Robotics, 22(5), 1011-1017".
@param R: The 3x3 rotation matrix to extract the tilt and torsion
angles from.
@@ -2347,9 +2345,7 @@
def tilt_torsion_to_R(phi, theta, sigma, R):
"""Generate a rotation matrix from the tilt and torsion rotation angles.
- This notation is taken from:
-
- Bonev, I. A. and Gosselin, C. M. (2006) Analytical determination of
the workspace of symmetrical spherical parallel mechanisms. IEEE
Transactions on Robotics, 22(5), 1011-1017.
+ This notation is taken from "Bonev, I. A. and Gosselin, C. M. (2006)
Analytical determination of the workspace of symmetrical spherical parallel
mechanisms. IEEE Transactions on Robotics, 22(5), 1011-1017".
@param phi: The angle defining the x-y plane rotation axis.
r11243 - in /1.3: generic_fns/structure/geometric.py info.py maths_fns/n_state_model.py maths_fns/rotation_matrix.py