Author: bugman
Date: Wed Nov 25 10:59:05 2009
New Revision: 9968
URL: http://svn.gna.org/viewcvs/relax?rev=9968&view=rev
Log:
Epydoc docstring fix and reformatting of generic_fns.pcs.read().
Modified:
1.3/generic_fns/pcs.py
Modified: 1.3/generic_fns/pcs.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pcs.py?rev=9968&r1=9967&r2=9968&view=diff
==============================================================================
--- 1.3/generic_fns/pcs.py (original)
+++ 1.3/generic_fns/pcs.py Wed Nov 25 10:59:05 2009
@@ -444,33 +444,21 @@
@type align_id: str
@param file: The name of the file to open.
@type file: str
- @param dir: The directory containing the file (defaults to
the current directory
- if None).
+ @param dir: The directory containing the file (defaults to
the current directory if None).
@type dir: str or None
- @param file_data: An alternative opening a file, if the data
already exists in the
- correct format. The format is a list of lists
where the first index
- corresponds to the row and the second the column.
+ @param file_data: An alternative opening a file, if the data
already exists in the correct format. The format is a list of lists where
the first index corresponds to the row and the second the column.
@type file_data: list of lists
- @keyword spin_id: The spin identification string.
- @type spin_id: None or str
- @keyword spin_id_col: The column containing the spin ID strings. If
supplied, the
- mol_name_col, res_name_col, res_num_col,
spin_name_col, and spin_num_col
- arguments must be none.
+ @keyword spin_id_col: The column containing the spin ID strings. If
supplied, the mol_name_col, res_name_col, res_num_col, spin_name_col, and
spin_num_col arguments must be none.
@type spin_id_col: int or None
- @keyword mol_name_col: The column containing the molecule name
information. If supplied,
- spin_id_col must be None.
+ @keyword mol_name_col: The column containing the molecule name
information. If supplied, spin_id_col must be None.
@type mol_name_col: int or None
- @keyword res_name_col: The column containing the residue name
information. If supplied,
- spin_id_col must be None.
+ @keyword res_name_col: The column containing the residue name
information. If supplied, spin_id_col must be None.
@type res_name_col: int or None
- @keyword res_num_col: The column containing the residue number
information. If supplied,
- spin_id_col must be None.
+ @keyword res_num_col: The column containing the residue number
information. If supplied, spin_id_col must be None.
@type res_num_col: int or None
- @keyword spin_name_col: The column containing the spin name information.
If supplied,
- spin_id_col must be None.
+ @keyword spin_name_col: The column containing the spin name information.
If supplied, spin_id_col must be None.
@type spin_name_col: int or None
- @keyword spin_num_col: The column containing the spin number
information. If supplied,
- spin_id_col must be None.
+ @keyword spin_num_col: The column containing the spin number
information. If supplied, spin_id_col must be None.
@type spin_num_col: int or None
@keyword data_col: The column containing the RDC data in Hz.
@type data_col: int or None
@@ -478,8 +466,7 @@
@type error_col: int or None
@keyword sep: The column separator which, if None, defaults to
whitespace.
@type sep: str or None
- @keyword spin_id: The spin ID string used to restrict data loading
to a subset of all
- spins.
+ @keyword spin_id: The spin ID string used to restrict data loading
to a subset of all spins.
@type spin_id: None or str
"""
r9968 - /1.3/generic_fns/pcs.py