summaryrefslogtreecommitdiff
path: root/numpy/lib/npyio.py
diff options
context:
space:
mode:
authorMatt Hall <matt@agilegeoscience.com>2021-04-16 15:52:47 -0300
committerGitHub <noreply@github.com>2021-04-16 15:52:47 -0300
commit54dc47920a2d674f2889374d1e7f8377b7ea17ff (patch)
tree5857c706da231f7f3bc653708e71a6618c203fb0 /numpy/lib/npyio.py
parenta6cd7b4f56c9fbffb9e72e8ffc5a0b9e70d1b06d (diff)
downloadnumpy-54dc47920a2d674f2889374d1e7f8377b7ea17ff.tar.gz
Fixes small typos in the genfromtext docstring
- `comments`: Added a full stop after 'discarded'. - `names`: changed 'proceeded' to 'preceeded'. - `excludelist`: inserted 'with' because it sounds odd without it; the example makes it clear. - `replace_space`: should strictly be "variable names" or "variables' names". The latter seems fussy so I chose the former.
Diffstat (limited to 'numpy/lib/npyio.py')
-rw-r--r--numpy/lib/npyio.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py
index efebb5fb7..9552579cf 100644
--- a/numpy/lib/npyio.py
+++ b/numpy/lib/npyio.py
@@ -1587,7 +1587,7 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
column, individually.
comments : str, optional
The character used to indicate the start of a comment.
- All the characters occurring on a line after a comment are discarded
+ All the characters occurring on a line after a comment are discarded.
delimiter : str, int, or sequence, optional
The string used to separate values. By default, any consecutive
whitespaces act as delimiter. An integer or sequence of integers
@@ -1614,15 +1614,15 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
``usecols = (1, 4, 5)`` will extract the 2nd, 5th and 6th columns.
names : {None, True, str, sequence}, optional
If `names` is True, the field names are read from the first line after
- the first `skip_header` lines. This line can optionally be proceeded
+ the first `skip_header` lines. This line can optionally be preceeded
by a comment delimiter. If `names` is a sequence or a single-string of
comma-separated names, the names will be used to define the field names
in a structured dtype. If `names` is None, the names of the dtype
fields will be used, if any.
excludelist : sequence, optional
A list of names to exclude. This list is appended to the default list
- ['return','file','print']. Excluded names are appended an underscore:
- for example, `file` would become `file_`.
+ ['return','file','print']. Excluded names are appended with an
+ underscore: for example, `file` would become `file_`.
deletechars : str, optional
A string combining invalid characters that must be deleted from the
names.
@@ -1631,7 +1631,7 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None,
autostrip : bool, optional
Whether to automatically strip white spaces from the variables.
replace_space : char, optional
- Character(s) used in replacement of white spaces in the variables
+ Character(s) used in replacement of white spaces in the variable
names. By default, use a '_'.
case_sensitive : {True, False, 'upper', 'lower'}, optional
If True, field names are case sensitive.