[Scipy-svn] r2660 - trunk/Lib/io

[scipy-svn at scipy.org]

Author: stefan
Date: 2007-01-31 10:51:37 -0600 (Wed, 31 Jan 2007)
New Revision: 2660

Modified:
   trunk/Lib/io/npfile.py
Log:
Update npfile.read docstring.


Modified: trunk/Lib/io/npfile.py
===================================================================
--- trunk/Lib/io/npfile.py	2007-01-31 16:46:06 UTC (rev 2659)
+++ trunk/Lib/io/npfile.py	2007-01-31 16:51:37 UTC (rev 2660)
@@ -156,15 +156,16 @@
     fwrite = write
     
     def read(self, shape, dt, endian=None, order=None):
-        ''' Read data from file and return it in a numpy array
+        '''Read data from file and return it in a numpy array.
         
         Inputs
+        ------
         shape     - shape of output array, or number of elements
-        dt        - dtype of array to write
+        dt        - dtype of array to be read
         endian    - endianness of written data
                     (can be None, 'dtype', '<', '>')
                     (default from self.endian)
-        order     - order of array to write (C, F)
+        order     - order of array to be read ('C' or 'F')
                     (default from self.order)
         '''
         endian, order = self._endian_order(endian, order)