Author: bugman
Date: Fri Jul 8 09:37:26 2011
New Revision: 13515
URL: http://svn.gna.org/viewcvs/relax?rev=13515&view=rev
Log:
Regularised all of the _doc_title_short strings.
Modified:
branches/gui_testing/prompt/deselect.py
branches/gui_testing/prompt/molecule.py
branches/gui_testing/prompt/pipe.py
branches/gui_testing/prompt/relax_data.py
branches/gui_testing/prompt/select.py
branches/gui_testing/prompt/sequence.py
branches/gui_testing/prompt/spin.py
branches/gui_testing/prompt/structure.py
Modified: branches/gui_testing/prompt/deselect.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/deselect.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/deselect.py (original)
+++ branches/gui_testing/prompt/deselect.py Fri Jul 8 09:37:26 2011
@@ -95,7 +95,7 @@
# The function doc info.
read._doc_title = "Deselect the spins contained in a file."
- read._doc_title_short = "Deselect spins from file."
+ read._doc_title_short = "Deselecting spins from file."
read._doc_args = [
["file", "The name of the file containing the list of spins to
deselect."],
["dir", "The directory where the file is located."],
@@ -151,7 +151,7 @@
# The function doc info.
reverse._doc_title = "Reversal of the spin selection for the given
spins."
- reverse._doc_title_short = "Reversal of spin selection."
+ reverse._doc_title_short = "Spin selection reversal."
reverse._doc_args = [
["spin_id", "The spin ID string."]
]
Modified: branches/gui_testing/prompt/molecule.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/molecule.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/molecule.py (original)
+++ branches/gui_testing/prompt/molecule.py Fri Jul 8 09:37:26 2011
@@ -54,7 +54,7 @@
# The function doc info.
copy._doc_title = "Copy all data associated with a molecule."
- copy._doc_title_short = "Copy a molecule."
+ copy._doc_title_short = "Molecule copying."
copy._doc_args = [
["pipe_from", "The data pipe containing the molecule from which the
data will be copied. This defaults to the current data pipe."],
["mol_from", "The name of the molecule from which to copy data
from."],
@@ -96,7 +96,7 @@
# The function doc info.
create._doc_title = "Create a new molecule."
- create._doc_title_short = "New molecule."
+ create._doc_title_short = "Molecule creation."
create._doc_args = [
["mol_name", "The name of the new molecule."],
["mol_type", "The type of molecule."]]
@@ -129,8 +129,8 @@
delete_molecule(mol_id=mol_id)
# The function doc info.
- delete._doc_title = "Molecule deletion."
- delete._doc_title_short = "Delete molecules."
+ delete._doc_title = "Deleting molecules from the relax data store."
+ delete._doc_title_short = "Molecule deletion."
delete._doc_args = [
["mol_id", "The molecule ID string."]]
delete._doc_desc = """
@@ -219,7 +219,7 @@
# The function doc info.
type._doc_title = "Set the molecule type."
- type._doc_title_short = "Set molecule type."
+ type._doc_title_short = "Setting molecule type."
type._doc_args = [
["mol_id", "The molecule ID string corresponding to one or more
molecules."],
["type", "The molecule type."],
Modified: branches/gui_testing/prompt/pipe.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/pipe.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/pipe.py (original)
+++ branches/gui_testing/prompt/pipe.py Fri Jul 8 09:37:26 2011
@@ -56,7 +56,7 @@
# The function doc info.
copy._doc_title = "Copy a data pipe."
- copy._doc_title_short = "Pipe copy."
+ copy._doc_title_short = "Data pipe copying."
copy._doc_args = [
["pipe_from", "The name of the source data pipe to copy the data
from."],
["pipe_to", "The name of the target data pipe to copy the data to."]
@@ -94,7 +94,7 @@
# The function doc info.
create._doc_title = "Add a new data pipe to the relax data store."
- create._doc_title_short = "Create a data pipe."
+ create._doc_title_short = "Data pipe creation."
create._doc_args = [
["pipe_name", "The name of the data pipe."],
["pipe_type", "The type of data pipe."]
@@ -128,7 +128,7 @@
# The function doc info.
current._doc_title = "Print the name of the current data pipe."
- current._doc_title_short = "The current pipe."
+ current._doc_title_short = "Current data pipe printing."
current._doc_examples = """
To run the user function, type:
@@ -173,7 +173,7 @@
# The function doc info.
display._doc_title = "Print a list of all the data pipes."
- display._doc_title_short = "Data pipe list."
+ display._doc_title_short = "Data pipe listing."
display._doc_examples = """
To run the user function, type:
Modified: branches/gui_testing/prompt/relax_data.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/relax_data.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/relax_data.py (original)
+++ branches/gui_testing/prompt/relax_data.py Fri Jul 8 09:37:26 2011
@@ -159,7 +159,7 @@
# The function doc info.
display._doc_title = "Display the data corresponding to the relaxation
data ID string."
- display._doc_title_short = "Display the relaxation data."
+ display._doc_title_short = "Displaying relaxation data."
display._doc_args = [
["ri_id", "The relaxation data ID string."]
]
@@ -188,7 +188,7 @@
# The function doc info.
peak_intensity_type._doc_title = "Specify the type of peak intensity
measurement used - i.e. height or volume."
- peak_intensity_type._doc_title_short = "Peak intensity type."
+ peak_intensity_type._doc_title_short = "Setting peak intensity type."
peak_intensity_type._doc_args = [
["ri_id", "The relaxation data ID string."],
["type", "The peak intensity type."]
@@ -242,7 +242,7 @@
# The function doc info.
read._doc_title = "Read R1, R2, or NOE relaxation data from a file."
- read._doc_title_short = "Read relaxation data from file."
+ read._doc_title_short = "Reading relaxation data from file."
read._doc_args = [
["ri_id", "The relaxation data ID string. This must be a unique
identifier."],
["ri_type", "The relaxation data type, i.e. 'R1', 'R2', or 'NOE'."],
@@ -311,7 +311,7 @@
# The function doc info.
temp_calibration._doc_title = "Specify the temperature calibration
method used."
- temp_calibration._doc_title_short = "Temperature calibration method."
+ temp_calibration._doc_title_short = "Setting temperature calibration
method."
temp_calibration._doc_args = [
["ri_id", "The relaxation data ID string."],
["method", "The calibration method."]
@@ -345,7 +345,7 @@
# The function doc info.
temp_control._doc_title = "Specify the temperature control method used."
- temp_control._doc_title_short = "Temperature control method."
+ temp_control._doc_title_short = "Setting temperature control method."
temp_control._doc_args = [
["ri_id", "The relaxation data ID string."],
["method", "The control method."]
Modified: branches/gui_testing/prompt/select.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/select.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/select.py (original)
+++ branches/gui_testing/prompt/select.py Fri Jul 8 09:37:26 2011
@@ -131,7 +131,7 @@
# The function doc info.
read._doc_title = "Select the spins contained in a file."
- read._doc_title_short = "Select spins from file."
+ read._doc_title_short = "Selecting spins from file."
read._doc_args = [
["file", "The name of the file containing the list of spins to
select."],
["dir", "The directory where the file is located."],
@@ -187,7 +187,7 @@
# The function doc info.
reverse._doc_title = "Reversal of the spin selection for the given
spins."
- reverse._doc_title_short = "Reversal of spin selection."
+ reverse._doc_title_short = "Spin selection reversal."
reverse._doc_args = [
["spin_id", "The spin ID string."]
]
Modified: branches/gui_testing/prompt/sequence.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/sequence.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/sequence.py (original)
+++ branches/gui_testing/prompt/sequence.py Fri Jul 8 09:37:26 2011
@@ -108,7 +108,7 @@
# The function doc info.
display._doc_title = "Display sequences of molecules, residues, and/or
spins."
- display._doc_title_short = "Sequence display."
+ display._doc_title_short = "Sequence data display."
display._doc_args = [
["sep", "The column separator (the default of None corresponds to
white space)."],
["mol_name_flag", "A flag whic if True will cause the molecule name
column to be shown."],
@@ -153,7 +153,7 @@
# The function doc info.
read._doc_title = "Read the molecule, residue, and spin sequence from a
file."
- read._doc_title_short = "Read sequence from file."
+ read._doc_title_short = "Sequence data reading."
read._doc_args = [
["file", "The name of the file containing the sequence data."],
["dir", "The directory where the file is located."],
@@ -237,7 +237,7 @@
# The function doc info.
write._doc_title = "Write the molecule, residue, and spin sequence to a
file."
- write._doc_title_short = "Write sequence to file."
+ write._doc_title_short = "Sequence data writing."
write._doc_args = [
["file", "The name of the file."],
["dir", "The directory name."],
Modified: branches/gui_testing/prompt/spin.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/spin.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/spin.py (original)
+++ branches/gui_testing/prompt/spin.py Fri Jul 8 09:37:26 2011
@@ -54,7 +54,7 @@
# The function doc info.
copy._doc_title = "Copy all data associated with a spin."
- copy._doc_title_short = "Spin copy."
+ copy._doc_title_short = "Spin copying."
copy._doc_args = [
["pipe_from", "The data pipe containing the spin from which the data
will be copied. This defaults to the current data pipe."],
["spin_from", "The spin identifier string of the spin to copy the
data from."],
@@ -236,7 +236,7 @@
# The function doc info.
element._doc_title = "Set the element type of the spin."
- element._doc_title_short = "Spin element."
+ element._doc_title_short = "Spin element type setting."
element._doc_args = [
["spin_id", "The spin identification string corresponding to one or
more spins."],
["element", "The IUPAC element name."],
Modified: branches/gui_testing/prompt/structure.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/structure.py?rev=13515&r1=13514&r2=13515&view=diff
==============================================================================
--- branches/gui_testing/prompt/structure.py (original)
+++ branches/gui_testing/prompt/structure.py Fri Jul 8 09:37:26 2011
@@ -291,7 +291,7 @@
# The function doc info.
load_spins._doc_title = "Load spins from the structure into the relax
data store."
- load_spins._doc_title_short = "Load spins from the structure."
+ load_spins._doc_title_short = "Loading spins from structure."
load_spins._doc_args = [
["spin_id", "The spin identification string."],
["combine_models", "A flag which specifies if spins from separate
models should be combined."],
@@ -359,7 +359,8 @@
generic_fns.structure.main.read_pdb(file=file, dir=dir,
read_mol=read_mol, set_mol_name=set_mol_name, read_model=read_model,
set_model_num=set_model_num, parser=parser)
# The function doc info.
- read_pdb._doc_title = "The PDB loading function."
+ read_pdb._doc_title = "Loading structures from PDB files."
+ read_pdb._doc_title_short = "PDB loading."
read_pdb._doc_args = [
["file", "The name of the PDB file."],
["dir", "The directory where the file is located."],
r13515 - /branches/gui_testing/prompt/