diff options
author | Simon Notley <simon.notley@dynniq.co.uk> | 2019-09-20 11:19:54 +0100 |
---|---|---|
committer | Simon Notley <simon.notley@dynniq.co.uk> | 2019-09-20 11:19:54 +0100 |
commit | f2cb97e8515d5bea0e28d01027c776369a612397 (patch) | |
tree | 09aa5ee7ec8576244d6aeb3761ac94e30d488d56 | |
parent | 815061c3ce9672b850147a0bc3535ebb220913e0 (diff) | |
download | numpy-f2cb97e8515d5bea0e28d01027c776369a612397.tar.gz |
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..7345d60d3 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 |