r22664 - /trunk/specific_analyses/parameter_object.py -- April 09, 2014 - 09:33

Author: bugman
Date: Wed Apr  9 09:33:12 2014
New Revision: 22664

URL: http://svn.gna.org/viewcvs/relax?rev=22664&view=rev
Log:
Updated the module docstring of specific_analyses.parameter_object to match 
its purpose.


Modified:
    trunk/specific_analyses/parameter_object.py

Modified: trunk/specific_analyses/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/parameter_object.py?rev=22664&r1=22663&r2=22664&view=diff
==============================================================================
--- trunk/specific_analyses/parameter_object.py (original)
+++ trunk/specific_analyses/parameter_object.py Wed Apr  9 09:33:12 2014
@@ -1,6 +1,6 @@
 
###############################################################################
 #                                                                            
 #
-# Copyright (C) 2012-2013 Edward d'Auvergne                                  
 #
+# Copyright (C) 2012-2014 Edward d'Auvergne                                  
 #
 #                                                                            
 #
 # This file is part of the program relax (http://www.nmr-relax.com).         
 #
 #                                                                            
 #
@@ -20,7 +20,10 @@
 
###############################################################################
 
 # Module docstring.
-"""A module of special objects used within the analysis specific API."""
+"""The parameter list object base class for the specific analyses.
+
+This provides a uniform interface for defining and handling parameters - 
either optimised or fixed - of the specific analyses.
+"""
 
 # Python module imports.
 from re import search