In pipe_control\spectrum.py .read()
Would that be adding to the epydoc string?

from:
    @keyword spin_id:       The spin ID string used to restrict data
loading to a subset of all spins.
    @type spin_id:          None or str

to:
    @keyword spin_id:       The spin ID string used to restrict data
loading to a subset of all spins. If 'auto' is provided for a NMRPipe
seriesTab formatted file, the ID's are auto generated in form of
Z_A{i}.
    @type spin_id:          None or str

And in user_functions\spectrum.py
from:
uf.add_keyarg(
    name = "spectrum_id",
    py_type = "str_or_str_list",
    desc_short = "spectrum ID string",
    desc = "The unique spectrum ID string to associate with the peak
intensity values."
)

to:
uf.add_keyarg(
    name = "spectrum_id",
    py_type = "str_or_str_list",
    desc_short = "spectrum ID string",
    desc = "The unique spectrum ID string or list of strings to
associate with the peak intensity values. If 'auto' is provided for a
NMRPipe seriesTab formatted file, the ID's are auto generated in form
of Z_A{i}."
)

Best
Troels Emtekær Linnet


2013/8/2 Edward d'Auvergne <[email protected]>:
> Oh, it needs documenting in the backend pipe_control.spectrum.read()
> function as well.
>
> Regards,
>
> Edward
>
> On 2 August 2013 20:59, Edward d'Auvergne <[email protected]> wrote:
>> All applied.  Now, the 'auto' option for the spectrum.peak_intensities
>> user function needs to be documented in the user function :)
>>
>> Regards,
>>
>> Edward
>>
>> On 2 August 2013 20:48, Troels E. Linnet
>> <[email protected]> wrote:
>>> Follow-up Comment #57, sr #3043 (project relax):
>>>
>>> Made changes according to suggestions.
>>>
>>>
>>>
>>> (file #18624)
>>>     _______________________________________________________
>>>
>>> Additional Item Attachment:
>>>
>>> File name: mtab.patch.tar.gz              Size:3 KB
>>>
>>>
>>>     _______________________________________________________
>>>
>>> Reply to this item at:
>>>
>>>   <http://gna.org/support/?3043>
>>>
>>> _______________________________________________
>>>   Message sent via/by Gna!
>>>   http://gna.org/
>>>
>>>
>>> _______________________________________________
>>> relax (http://www.nmr-relax.com)
>>>
>>> This is the relax-devel mailing list
>>> [email protected]
>>>
>>> To unsubscribe from this list, get a password
>>> reminder, or change your subscription options,
>>> visit the list information page at
>>> https://mail.gna.org/listinfo/relax-devel
>>
>> _______________________________________________
>> relax (http://www.nmr-relax.com)
>>
>> This is the relax-devel mailing list
>> [email protected]
>>
>> To unsubscribe from this list, get a password
>> reminder, or change your subscription options,
>> visit the list information page at
>> https://mail.gna.org/listinfo/relax-devel
>
> _______________________________________________
> relax (http://www.nmr-relax.com)
>
> This is the relax-devel mailing list
> [email protected]
>
> To unsubscribe from this list, get a password
> reminder, or change your subscription options,
> visit the list information page at
> https://mail.gna.org/listinfo/relax-devel

_______________________________________________
relax (http://www.nmr-relax.com)

This is the relax-devel mailing list
[email protected]

To unsubscribe from this list, get a password
reminder, or change your subscription options,
visit the list information page at
https://mail.gna.org/listinfo/relax-devel

Reply via email to