diff options
author | Jaime <jaime.frio@gmail.com> | 2015-03-02 12:32:24 -0800 |
---|---|---|
committer | Jaime <jaime.frio@gmail.com> | 2015-03-02 12:32:24 -0800 |
commit | 03506a9e72d85d596021e11e9b39c5a0fd1f2eba (patch) | |
tree | d5fd6bbe2d034e12a18c06f4299887166ed6ff81 /numpy/lib | |
parent | 83b680b84a83c3e4b56e79396c395e30af650ba8 (diff) | |
parent | 6ca778d275ade854cfc81a6a975230c4ccd9402c (diff) | |
download | numpy-03506a9e72d85d596021e11e9b39c5a0fd1f2eba.tar.gz |
Merge pull request #5622 from rmcgibbo/maint-docstrings
MAINT: Reconcile docstrings and function signatures where they disagree
Diffstat (limited to 'numpy/lib')
-rw-r--r-- | numpy/lib/_iotools.py | 6 | ||||
-rw-r--r-- | numpy/lib/index_tricks.py | 2 | ||||
-rw-r--r-- | numpy/lib/npyio.py | 4 | ||||
-rw-r--r-- | numpy/lib/recfunctions.py | 4 |
4 files changed, 8 insertions, 8 deletions
diff --git a/numpy/lib/_iotools.py b/numpy/lib/_iotools.py index 316704b42..54ed96490 100644 --- a/numpy/lib/_iotools.py +++ b/numpy/lib/_iotools.py @@ -160,7 +160,7 @@ class LineSplitter(object): delimiter : str, int, or sequence of ints, optional If a string, character used to delimit consecutive fields. If an integer or a sequence of integers, width(s) of each field. - comment : str, optional + comments : str, optional Character used to mark the beginning of a comment. Default is '#'. autostrip : bool, optional Whether to strip each individual field. Default is True. @@ -271,7 +271,7 @@ class NameValidator(object): deletechars : str, optional A string combining invalid characters that must be deleted from the names. - casesensitive : {True, False, 'upper', 'lower'}, optional + case_sensitive : {True, False, 'upper', 'lower'}, optional * If True, field names are case-sensitive. * If False or 'upper', field names are converted to upper case. * If 'lower', field names are converted to lower case. @@ -341,7 +341,7 @@ class NameValidator(object): defaultfmt : str, optional Default format string, used if validating a given string reduces its length to zero. - nboutput : integer, optional + nbfields : integer, optional Final number of validated names, used to expand or shrink the initial list of names. diff --git a/numpy/lib/index_tricks.py b/numpy/lib/index_tricks.py index eb9aad6ad..e97338106 100644 --- a/numpy/lib/index_tricks.py +++ b/numpy/lib/index_tricks.py @@ -480,7 +480,7 @@ class ndenumerate(object): Parameters ---------- - a : ndarray + arr : ndarray Input array. See Also diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index 0632ba1f8..2b01caed9 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -1240,8 +1240,8 @@ def genfromtxt(fname, dtype=float, comments='#', delimiter=None, The string used to separate values. By default, any consecutive whitespaces act as delimiter. An integer or sequence of integers can also be provided as width(s) of each field. - skip_rows : int, optional - `skip_rows` was deprecated in numpy 1.5, and will be removed in + skiprows : int, optional + `skiprows` was deprecated in numpy 1.5, and will be removed in numpy 2.0. Please use `skip_header` instead. skip_header : int, optional The number of lines to skip at the beginning of the file. diff --git a/numpy/lib/recfunctions.py b/numpy/lib/recfunctions.py index a61b1749b..4ae1079d2 100644 --- a/numpy/lib/recfunctions.py +++ b/numpy/lib/recfunctions.py @@ -268,7 +268,7 @@ def izip_records(seqarrays, fill_value=None, flatten=True): Parameters ---------- - seqarray : sequence of arrays + seqarrays : sequence of arrays Sequence of arrays. fill_value : {None, integer} Value used to pad shorter iterables. @@ -683,7 +683,7 @@ def stack_arrays(arrays, defaults=None, usemask=True, asrecarray=False, Parameters ---------- - seqarrays : array or sequence + arrays : array or sequence Sequence of input arrays. defaults : dictionary, optional Dictionary mapping field names to the corresponding default values. |