Author: bugman
Date: Sat Feb 2 16:46:16 2013
New Revision: 18393
URL: http://svn.gna.org/viewcvs/relax?rev=18393&view=rev
Log:
Module docstring additions and improvements for the relax data store modules.
Modified:
trunk/data/align_tensor.py
trunk/data/diff_tensor.py
trunk/data/exp_info.py
trunk/data/gui.py
trunk/data/interatomic.py
trunk/data/mol_res_spin.py
trunk/data/pipe_container.py
trunk/data/prototype.py
trunk/data/relax_xml.py
Modified: trunk/data/align_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/align_tensor.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/align_tensor.py (original)
+++ trunk/data/align_tensor.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2012 Edward d'Auvergne
#
+# Copyright (C) 2003-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -19,6 +19,9 @@
#
#
###############################################################################
+# Module docstring.
+"""The alignment tensor objects of the relax data store."""
+
# Python module imports.
from re import search
from math import cos, sin
Modified: trunk/data/diff_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/diff_tensor.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/diff_tensor.py (original)
+++ trunk/data/diff_tensor.py Sat Feb 2 16:46:16 2013
@@ -19,6 +19,9 @@
#
#
###############################################################################
+# Module docstring.
+"""The diffusion tensor objects of the relax data store."""
+
# Python module imports.
from copy import deepcopy
from re import search
Modified: trunk/data/exp_info.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/exp_info.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/exp_info.py (original)
+++ trunk/data/exp_info.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2009-2012 Edward d'Auvergne
#
+# Copyright (C) 2009-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""Module holding the experimental information data container."""
+"""The experimental information data container of the relax data store."""
# relax module imports.
from data.data_classes import RelaxListType, Element
Modified: trunk/data/gui.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/gui.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/gui.py (original)
+++ trunk/data/gui.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2010-2012 Edward d'Auvergne
#
+# Copyright (C) 2010-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""Data store objects for holding all the GUI specific variables."""
+"""The GUI data objects of the relax data store."""
# relax module imports.
from data.data_classes import Element, RelaxListType
Modified: trunk/data/interatomic.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/interatomic.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/interatomic.py (original)
+++ trunk/data/interatomic.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2012 Edward d'Auvergne
#
+# Copyright (C) 2007-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""The interatomic data containers."""
+"""The interatomic data containers of the relax data store."""
# Python module imports.
from re import match
Modified: trunk/data/mol_res_spin.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/mol_res_spin.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/mol_res_spin.py (original)
+++ trunk/data/mol_res_spin.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2012 Edward d'Auvergne
#
+# Copyright (C) 2007-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""The molecule-residue-spin containers."""
+"""The molecule-residue-spin containers of the relax data store."""
# Python module imports.
import numpy
Modified: trunk/data/pipe_container.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/pipe_container.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/pipe_container.py (original)
+++ trunk/data/pipe_container.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2012 Edward d'Auvergne
#
+# Copyright (C) 2007-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -18,6 +18,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""The data pipe objects of the relax data store."""
# Python module imports.
from re import match
Modified: trunk/data/prototype.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/prototype.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/prototype.py (original)
+++ trunk/data/prototype.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2008 Edward d'Auvergne
#
+# Copyright (C) 2007-2003 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
Modified: trunk/data/relax_xml.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/data/relax_xml.py?rev=18393&r1=18392&r2=18393&view=diff
==============================================================================
--- trunk/data/relax_xml.py (original)
+++ trunk/data/relax_xml.py Sat Feb 2 16:46:16 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2008-2012 Edward d'Auvergne
#
+# Copyright (C) 2008-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""Module containing generic fns for creation and parsing of XML
representations of python objects."""
+"""Module containing generic functions for creation and parsing of XML
representations of Python objects."""
# Python module imports.
import numpy
r18393 - /trunk/data/