Author: bugman Date: Thu Nov 20 11:03:31 2014 New Revision: 26649 URL: http://svn.gna.org/viewcvs/relax?rev=26649&view=rev Log: Epydoc docstring fixes for the lib.spectrum.nmrpipe module.
This is for the API documentation at http://www.nmr-relax.com/api/index.html. The show_apod_rmsd_to_file() and show_apod_rmsd_dir_to_files() function docstrings have both been modified. Modified: trunk/lib/spectrum/nmrpipe.py Modified: trunk/lib/spectrum/nmrpipe.py URL: http://svn.gna.org/viewcvs/relax/trunk/lib/spectrum/nmrpipe.py?rev=26649&r1=26648&r2=26649&view=diff ============================================================================== --- trunk/lib/spectrum/nmrpipe.py (original) +++ trunk/lib/spectrum/nmrpipe.py Thu Nov 20 11:03:31 2014 @@ -267,13 +267,13 @@ @keyword dir: The directory where the file is located. @type dir: str @keyword path_to_command: If showApod not in PATH, then specify absolute path as: /path/to/showApod - @type dir: str + @type path_to_command: str @keyword outdir: The directory where to write the file. If 'None', then write in same directory. @type outdir: str @param force: Boolean argument which if True causes the file to be overwritten if it already exists. @type force: bool - @return: Write the 'Noise Std Dev' from showApod to a file with same file filename, with ending '.rmsd'. - @rtype: filepath + @return: Write the 'Noise Std Dev' from showApod to a file with same file filename, with ending '.rmsd'. This will be a file path. + @rtype: str """ # Call extract function. @@ -318,13 +318,13 @@ @keyword dir: The directory where the files is located. @type dir: str @keyword path_to_command: If showApod not in PATH, then specify absolute path as: /path/to/showApod - @type dir: str + @type path_to_command: str @keyword outdir: The directory where to write the files. If 'None', then write in same directory. @type outdir: str @param force: Boolean argument which if True causes the file to be overwritten if it already exists. @type force: bool - @return: Write the 'Noise Std Dev' from showApod to a file with same file filename, with ending '.rmsd'. - @rtype: list of filepaths + @return: Write the 'Noise Std Dev' from showApod to a file with same file filename, with ending '.rmsd'. This will be a list of file paths. + @rtype: list of str """ # First get correct dir, no matter if dir is specified with or without system folder separator. _______________________________________________ relax (http://www.nmr-relax.com) This is the relax-commits 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-commits
