Skip to content

Commit

Permalink
Merge pull request numpy#14555 from sonotley/genfromtext_doc_clarify
Browse files Browse the repository at this point in the history
DOC: clarify input types in basics.io.genfromtxt.rst
  • Loading branch information
WarrenWeckesser authored Sep 22, 2019
2 parents 2d1bc73 + 133b1f7 commit e5730e1
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions doc/source/user/basics.io.genfromtxt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e5730e1

Please sign in to comment.