SF.net SVN: matplotlib: [5381] branches/v0_91_maint/lib/matplotlib/mlab.py

[<sa...@us...>]

Revision: 5381
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5381&view=rev
Author:   sameerd
Date:     2008-06-04 09:49:19 -0700 (Wed, 04 Jun 2008)

Log Message:
-----------
Docstring changes

Modified Paths:
--------------
    branches/v0_91_maint/lib/matplotlib/mlab.py

Modified: branches/v0_91_maint/lib/matplotlib/mlab.py
===================================================================
--- branches/v0_91_maint/lib/matplotlib/mlab.py	2008-06-04 13:09:55 UTC (rev 5380)
+++ branches/v0_91_maint/lib/matplotlib/mlab.py	2008-06-04 16:49:19 UTC (rev 5381)
@@ -48,7 +48,7 @@
    * rec2txt          : pretty print a record array
    * rec2csv          : store record array in CSV file
    * csv2rec          : import record array from CSV file with type inspection
-   * rec_append_field : add a field/array to record array
+   * rec_append_fields: adds  field(s)/array(s) to record array
    * rec_drop_fields  : drop fields from record array
    * rec_join         : join two record arrays on sequence of fields
    * rec_groupby      : summarize data by groups (similar to SQL GROUP BY)
@@ -1952,7 +1952,10 @@
     else: return b
 
 def rec_append_field(rec, name, arr, dtype=None):
-    'return a new record array with field name populated with data from array arr'
+    """
+    return a new record array with field name populated with data from array arr.
+    This function is Depreacted. Please use rec_append_fields.
+    """
     warnings.warn("use rec_append_fields", DeprecationWarning)
     return rec_append_fields(rec, name, arr, dtype)
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.