r9096 - /branches/frame_order/maths_fns/frame_order_models.py -- June 19, 2009 - 11:51

Author: bugman
Date: Fri Jun 19 11:51:24 2009
New Revision: 9096

URL: http://svn.gna.org/viewcvs/relax?rev=9096&view=rev
Log:
Docstring update.


Modified:
    branches/frame_order/maths_fns/frame_order_models.py

Modified: branches/frame_order/maths_fns/frame_order_models.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/frame_order/maths_fns/frame_order_models.py?rev=9096&r1=9095&r2=9096&view=diff
==============================================================================
--- branches/frame_order/maths_fns/frame_order_models.py (original)
+++ branches/frame_order/maths_fns/frame_order_models.py Fri Jun 19 11:51:24 
2009
@@ -39,6 +39,8 @@
     def __init__(self, model=None, frame_order_2nd=None):
         """Set up the target functions for the Frame Order theories.
         
+        @keyword model:             The name of the Frame Order model.
+        @type model:                str
         @keyword frame_order_2nd:   The numerical values of the 2nd degree 
Frame Order matrix.  If
                                     supplied, the target functions will 
optimise directly to these
                                     values.