diff options
| author | cookedm <cookedm@localhost> | 2006-11-21 17:13:14 +0000 |
|---|---|---|
| committer | cookedm <cookedm@localhost> | 2006-11-21 17:13:14 +0000 |
| commit | 886c1db715d9b79cf2af945c880aee96a41e24fb (patch) | |
| tree | 4a587ebc58775f3dc9a4a7f76379a47e2fb65a74 /numpy/add_newdocs.py | |
| parent | c090cbc510fcf2e193bcb160dd3b9a8f4ffc76c8 (diff) | |
| download | numpy-886c1db715d9b79cf2af945c880aee96a41e24fb.tar.gz | |
better doc for a.dump and a.dumps
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 07df1f38d..9cd1c89a5 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -771,7 +771,9 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('diagonal', add_newdoc('numpy.core.multiarray', 'ndarray', ('dump', - """a.dump(file) Dump to specified file. + """a.dump(file) Dump a pickle of the array to the specified file. + + The array can be read back with pickle.load or numpy.load Arguments: file -- string naming the dump file. @@ -780,8 +782,9 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('dump', add_newdoc('numpy.core.multiarray', 'ndarray', ('dumps', - """a.dumps() -> string containing the dump? + """a.dumps() returns the pickle of the array as a string. + pickle.loads or numpy.loads will convert the string back to an array. """)) |