Author: tlinnet
Date: Mon Dec 8 00:03:07 2014
New Revision: 27008
URL: http://svn.gna.org/viewcvs/relax?rev=27008&view=rev
Log:
Comment fix in user function select.sn_ratio and deselect.sn_ratio.
Modified:
trunk/user_functions/deselect.py
trunk/user_functions/select.py
Modified: trunk/user_functions/deselect.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/deselect.py?rev=27008&r1=27007&r2=27008&view=diff
==============================================================================
--- trunk/user_functions/deselect.py (original)
+++ trunk/user_functions/deselect.py Mon Dec 8 00:03:07 2014
@@ -286,7 +286,7 @@
# The deselect.sn_ratio user function.
uf = uf_info.add_uf("deselect.sn_ratio")
-uf.title = "Deselect spins with signal to noise ratio higher or lower than
ratio."
+uf.title = "Deselect spins with signal to noise ratio higher or lower than
the given ratio."
uf.title_short = "Spin signal to noise deselection."
uf.display = True
uf.add_keyarg(
@@ -330,8 +330,9 @@
)
# Description.
uf.desc.append(Desc_container())
-uf.desc[-1].add_paragraph("The comparison operation is the method which to
deselect spins accorfing to: operation(sn_ratio, ratio).")
-uf.desc[-1].add_paragraph("The 'all_sn' flag default is False, meaning that
if any of the spins signal to noise levels evaluates to True in the
comparison, the spin is deselected.")
+uf.desc[-1].add_paragraph("The comparison operation is the method which to
deselect spins according to: operation(sn_ratio, ratio).")
+uf.desc[-1].add_paragraph("The possible operations are: '<':strictly less
than, '<=':less than or equal, '>':strictly greater than, '>=':greater than
or equal, '==':equal, '!=':not equal.")
+uf.desc[-1].add_paragraph("The 'all_sn' flag default is False, meaning that
if any of the spin's signal to noise levels evaluates to True in the
comparison, the spin is deselected.")
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
uf.desc[-1].add_paragraph("To deselect all spins with a signal to noise
ratio lower than 10.0:")
Modified: trunk/user_functions/select.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/select.py?rev=27008&r1=27007&r2=27008&view=diff
==============================================================================
--- trunk/user_functions/select.py (original)
+++ trunk/user_functions/select.py Mon Dec 8 00:03:07 2014
@@ -365,7 +365,7 @@
# The select.sn_ratio user function.
uf = uf_info.add_uf("select.sn_ratio")
-uf.title = "Select spins with signal to noise ratio higher or lower than
ratio."
+uf.title = "Select spins with signal to noise ratio higher or lower than the
given ratio."
uf.title_short = "Spin signal to noise selection."
uf.display = True
uf.add_keyarg(
@@ -409,8 +409,9 @@
)
# Description.
uf.desc.append(Desc_container())
-uf.desc[-1].add_paragraph("The comparison operation is the method which to
select spins accorfing to: operation(sn_ratio, ratio).")
-uf.desc[-1].add_paragraph("The 'all_sn' flag default is True, meaning that
if all of the spins signal to noise levels evaluates to True in the
comparison, the spin is selected.")
+uf.desc[-1].add_paragraph("The comparison operation is the method which to
select spins according to: operation(sn_ratio, ratio).")
+uf.desc[-1].add_paragraph("The possible operations are: '<':strictly less
than, '<=':less than or equal, '>':strictly greater than, '>=':greater than
or equal, '==':equal, '!=':not equal.")
+uf.desc[-1].add_paragraph("The 'all_sn' flag default is True, meaning that
if all of the spin's signal to noise levels evaluates to True in the
comparison, the spin is selected.")
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
uf.desc[-1].add_paragraph("To select all spins with a signal to noise ratio
higher than 10.0:")
r27008 - in /trunk/user_functions: deselect.py select.py