Author: bugman
Date: Mon Dec 27 17:08:06 2010
New Revision: 11979
URL: http://svn.gna.org/viewcvs/relax?rev=11979&view=rev
Log:
Merged revisions 11966-11967 via svnmerge from
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/1.3
........
r11966 | bugman | 2010-12-27 13:17:01 +0100 (Mon, 27 Dec 2010) | 3 lines
Epydoc docstring fixes.
........
r11967 | bugman | 2010-12-27 13:42:03 +0100 (Mon, 27 Dec 2010) | 3 lines
The sample_scripts and scripts directories are no longer parsed for the API
documentation.
........
Modified:
branches/bieri_gui/ (props changed)
branches/bieri_gui/generic_fns/structure/cones.py
branches/bieri_gui/maths_fns/coord_transform.py
branches/bieri_gui/scons/manuals.py
branches/bieri_gui/specific_fns/n_state_model.py
Propchange: branches/bieri_gui/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Mon Dec 27 17:08:06 2010
@@ -1,1 +1,1 @@
-/1.3:1-11915
+/1.3:1-11978
Modified: branches/bieri_gui/generic_fns/structure/cones.py
URL:
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/generic_fns/structure/cones.py?rev=11979&r1=11978&r2=11979&view=diff
==============================================================================
--- branches/bieri_gui/generic_fns/structure/cones.py (original)
+++ branches/bieri_gui/generic_fns/structure/cones.py Mon Dec 27 17:08:06 2010
@@ -50,7 +50,7 @@
@param phi: The polar angle.
@type phi: float
@param theta: The azimuthal angle.
- @type phi: float
+ @type theta: float
@return: True if the point is within the cone, False
otherwise.
@rtype: bool
"""
Modified: branches/bieri_gui/maths_fns/coord_transform.py
URL:
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/maths_fns/coord_transform.py?rev=11979&r1=11978&r2=11979&view=diff
==============================================================================
--- branches/bieri_gui/maths_fns/coord_transform.py (original)
+++ branches/bieri_gui/maths_fns/coord_transform.py Mon Dec 27 17:08:06 2010
@@ -63,10 +63,10 @@
The parameter r is the radial distance, theta is the polar angle, and
phi is the azimuth.
- @param vector: The spherical coordinate vector [r, theta, phi].
- @type vector: 3D array or list
- @return: The Cartesian vector [x, y, z].
- @rtype: numpy rank-1, 3D array
+ @param spherical_vect: The spherical coordinate vector [r, theta, phi].
+ @type spherical_vect: 3D array or list
+ @param cart_vect: The Cartesian vector [x, y, z].
+ @type cart_vect: 3D array or list
"""
# Trig alias.
Modified: branches/bieri_gui/scons/manuals.py
URL:
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/scons/manuals.py?rev=11979&r1=11978&r2=11979&view=diff
==============================================================================
--- branches/bieri_gui/scons/manuals.py (original)
+++ branches/bieri_gui/scons/manuals.py Mon Dec 27 17:08:06 2010
@@ -93,7 +93,7 @@
# exclude
# The list of objects to exclude.
- exclude = ['minfx']
+ exclude = ['sample_scripts', 'scripts']
# output
# The type of output that should be generated. Should be one
Modified: branches/bieri_gui/specific_fns/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/branches/bieri_gui/specific_fns/n_state_model.py?rev=11979&r1=11978&r2=11979&view=diff
==============================================================================
--- branches/bieri_gui/specific_fns/n_state_model.py (original)
+++ branches/bieri_gui/specific_fns/n_state_model.py Mon Dec 27 17:08:06 2010
@@ -2497,7 +2497,7 @@
"""Return the array of simulation parameter values.
@param model_info: The global model index originating from
model_loop().
- @type data_id: int
+ @type model_info: int
@param index: The index of the parameter to return the array
of values for.
@type index: int
@return: The array of simulation parameter values.
r11979 - in /branches/bieri_gui: ./ generic_fns/structure/ maths_fns/ scons/ specific_fns/