r9697 - /branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py -- October 09, 2009 - 15:48

Author: bugman
Date: Fri Oct  9 15:48:19 2009
New Revision: 9697

URL: http://svn.gna.org/viewcvs/relax?rev=9697&view=rev
Log:
Added a docstring to tag_setup().


Modified:
    branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py

Modified: branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py?rev=9697&r1=9696&r2=9697&view=diff
==============================================================================
--- branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py (original)
+++ branches/bmrb/bmrblib/kinetics/heteronucl_NOEs_v3_1.py Fri Oct  9 
15:48:19 2009
@@ -92,6 +92,14 @@
     """v3.1 HeteronuclNOE tag category."""
 
     def tag_setup(self, tag_category_label=None, sep=None):
+        """Replacement method for setting up the tag names.
+
+        @keyword tag_category_label:    The tag name prefix specific for the 
tag category.
+        @type tag_category_label:       None or str
+        @keyword sep:                   The string separating the tag name 
prefix and suffix.
+        @type sep:                      str
+        """
+
         # Execute the base class tag_setup() method.
         HeteronuclNOE.tag_setup(self, tag_category_label='Heteronucl_NOE', 
sep=sep)