diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2008-02-09 00:45:11 +0000 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2008-02-09 00:45:11 +0000 |
commit | fbc211df7a2ebd27efe45cf4f943e21f5ad9b104 (patch) | |
tree | 9cea7049a873c0cd38bda75a5a5fe8d2d401b4fd /numpy/add_newdocs.py | |
parent | a2df3f7818deaf51d08b8bd9095e05d1011b46a5 (diff) | |
parent | d42ab1598a44cb00bffcc907605013eca012dbf9 (diff) | |
download | numpy-fbc211df7a2ebd27efe45cf4f943e21f5ad9b104.tar.gz |
Merge maskedarray branch up to r4776.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 91c6a6e80..7955beca7 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -1,7 +1,7 @@ # This is only meant to add docs to # objects defined in C-extension modules. # The purpose is to allow easier editing of the -# docstrings without requiring a re-compile. +# docstrings without requiring a re-compile. from lib import add_newdoc add_newdoc('numpy.core','dtype', @@ -216,6 +216,7 @@ add_newdoc('numpy.core.multiarray','fromstring', size is determined by the size of string. If sep is not empty then the string is interpreted in ASCII mode and converted to the desired number type using sep as the separator between elements (extra whitespace is ignored). + ASCII integer conversions are base-10; octal and hex are not supported. """) @@ -237,7 +238,7 @@ add_newdoc('numpy.core.multiarray','fromfile', open file object or string containing file name. dtype : data-type data type of the returned array - count : int + count : int number of items to read (-1 mean 'all') sep : string separater between items if file is a text file (default "") @@ -1106,8 +1107,8 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('round', is done if the array is not of float type and 'decimals' is >= 0. The keyword 'out' may be used to specify a different array to hold the - result rather than the default new array. If the type of the array - specified by 'out' differs from that of 'a', the result is cast to the + result rather than the default new array. If the type of the array + specified by 'out' differs from that of 'a', the result is cast to the new type, otherwise the original type is kept. Floats round to floats by default. @@ -1208,7 +1209,7 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('sort', |'heapsort' | 3 | O(n*log(n)) | 0 | no | |------------------------------------------------------| - All the sort algorithms make temporary copies of the data when the sort is + All the sort algorithms make temporary copies of the data when the sort is not along the last axis. Consequently, sorts along the last axis are faster and use less space than sorts along other axis. """)) |