diff options
author | jason king <pizza@netspace.net.au> | 2015-09-05 23:01:24 +1000 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2015-10-04 14:42:30 -0600 |
commit | ae2d0bb7c2d227e893195cc3e52477567781e2db (patch) | |
tree | 6506061afe34a2aca455bf287c6ab2ed435d1da0 /doc/source | |
parent | 2bc213bb3a75069775bc2a6cbc43dc26e1664835 (diff) | |
download | numpy-ae2d0bb7c2d227e893195cc3e52477567781e2db.tar.gz |
DOC: Update docs for numpy.genfromtxt.
Note that a list of strings can be passed as the first parameter.
The strings are treated as the lines in a file.
Closes #6247
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/user/basics.io.genfromtxt.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/user/basics.io.genfromtxt.rst b/doc/source/user/basics.io.genfromtxt.rst index 11205e555..75ba8a11d 100644 --- a/doc/source/user/basics.io.genfromtxt.rst +++ b/doc/source/user/basics.io.genfromtxt.rst @@ -29,9 +29,9 @@ Defining the input The only mandatory argument of :func:`~numpy.genfromtxt` is the source of the data. It can be a string corresponding to the name of a local or remote file, or a file-like object with a :meth:`read` method (such as an -actual file or a :class:`StringIO.StringIO` object). If the argument is -the URL of a remote file, this latter is automatically downloaded in the -current directory. +actual file or a :class:`StringIO.StringIO` object), a list of strings, or +a generator. If the argument is the URL of a remote file, then the file +is automatically downloaded to the current directory. The input file can be a text file or an archive. Currently, the function recognizes :class:`gzip` and :class:`bz2` (`bzip2`) archives. The type of |