Author: bugman
Date: Thu Nov 20 11:00:38 2014
New Revision: 26648
URL: http://svn.gna.org/viewcvs/relax?rev=26648&view=rev
Log:
Epydoc docstring fixes and expansion for the lib.io.sort_filenames() function.
Modified:
trunk/lib/io.py
Modified: trunk/lib/io.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/lib/io.py?rev=26648&r1=26647&r2=26648&view=diff
==============================================================================
--- trunk/lib/io.py (original)
+++ trunk/lib/io.py Thu Nov 20 11:00:38 2014
@@ -484,10 +484,12 @@
def sort_filenames(filenames=None, rev=False):
"""Sort the given list in alphanumeric order. Should be equivalent to
unix 'ls -n' command.
- @keyword filenames: The list of filenames
- @type l: list of strings
- @keyword rev: Flag, if the list should be reverted
- @type rev: boold
+ @keyword filenames: The list of file names to sort.
+ @type filenames: list of str
+ @keyword rev: Flag which if True will cause the list to be reversed.
+ @type rev: bool
+ @return: The sorted list of file names.
+ @rtype: list of str
"""
# Define function to convert to integers if text is digit.
_______________________________________________
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
