diff options
author | Warren Weckesser <warren.weckesser@gmail.com> | 2019-09-22 09:32:53 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-22 09:32:53 -0400 |
commit | e5730e11b0448350cf2fd4cafc7204fdb9f6f79e (patch) | |
tree | 2184bc9425c0387cb260c3b60f16baff1ab4913f | |
parent | 2d1bc73d667ae6ac425cfd05a85d3727b0570115 (diff) | |
parent | 133b1f7363d785ae53556283ce707481ac35b1ee (diff) | |
download | numpy-e5730e11b0448350cf2fd4cafc7204fdb9f6f79e.tar.gz |
Merge pull request #14555 from sonotley/genfromtext_doc_clarify
DOC: clarify input types in basics.io.genfromtxt.rst
-rw-r--r-- | doc/source/user/basics.io.genfromtxt.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/source/user/basics.io.genfromtxt.rst b/doc/source/user/basics.io.genfromtxt.rst index 6ef80bf8e..19e37eabc 100644 --- a/doc/source/user/basics.io.genfromtxt.rst +++ b/doc/source/user/basics.io.genfromtxt.rst @@ -27,13 +27,13 @@ Defining the input ================== The only mandatory argument of :func:`~numpy.genfromtxt` is the source of -the data. It can be a string, a list of strings, or a generator. If a -single string is provided, it is assumed to be the name of a local or -remote file, or an open file-like object with a :meth:`read` method, for -example, a file or :class:`io.StringIO` object. If a list of strings -or a generator returning strings is provided, each string is treated as one -line in a file. When the URL of a remote file is passed, the file is -automatically downloaded to the current directory and opened. +the data. It can be a string, a list of strings, a generator or an open +file-like object with a :meth:`read` method, for example, a file or +:class:`io.StringIO` object. If a single string is provided, it is assumed +to be the name of a local or remote file. If a list of strings or a generator +returning strings is provided, each string is treated as one line in a file. +When the URL of a remote file is passed, the file is automatically downloaded +to the current directory and opened. Recognized file types are text files and archives. Currently, the function recognizes :class:`gzip` and :class:`bz2` (`bzip2`) archives. The type of |