r17421 - /trunk/user_functions/spin.py -- September 03, 2012 - 10:19

Author: bugman
Date: Mon Sep  3 10:19:35 2012
New Revision: 17421

URL: http://svn.gna.org/viewcvs/relax?rev=17421&view=rev
Log:
Fix for the spin.create user function documentation - the prompt examples 
were wrong.


Modified:
    trunk/user_functions/spin.py

Modified: trunk/user_functions/spin.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/spin.py?rev=17421&r1=17420&r2=17421&view=diff
==============================================================================
--- trunk/user_functions/spin.py (original)
+++ trunk/user_functions/spin.py Mon Sep  3 10:19:35 2012
@@ -149,10 +149,10 @@
 uf.desc[-1].add_paragraph("This will add a new spin data container to the 
relax data storage object.  The same spin number cannot be used more than 
once.")
 # Prompt examples.
 uf.desc.append(Desc_container("Prompt examples"))
-uf.desc[-1].add_paragraph("The following sequence of commands will generate 
the sequence 1 C4, 2 C9, 3 C15:")
-uf.desc[-1].add_prompt("relax> spin.create(1, 'C4')")
-uf.desc[-1].add_prompt("relax> spin.create(2, 'C9')")
-uf.desc[-1].add_prompt("relax> spin.create(3, 'C15')")
+uf.desc[-1].add_paragraph("The following sequence of commands will add the 
spins 1 C4, 2 C9, 3 C15 to residue number 10:")
+uf.desc[-1].add_prompt("relax> spin.create('C4',  1, res_num=10)")
+uf.desc[-1].add_prompt("relax> spin.create('C9',  2, res_num=10)")
+uf.desc[-1].add_prompt("relax> spin.create('C15', 3, res_num=10)")
 uf.backend = create_spin
 uf.menu_text = "c&reate"
 uf.gui_icon = "oxygen.actions.list-add-relax-blue"