diff options
author | endolith <endolith@gmail.com> | 2013-03-19 20:37:26 -0400 |
---|---|---|
committer | endolith <endolith@gmail.com> | 2013-03-19 20:37:45 -0400 |
commit | 0d35127755ba6812e722a311bfab5e6523c444bb (patch) | |
tree | a74df25f29209efe1dbb96a19b2a84d7d8a3ea8b /numpy | |
parent | 653a6fd443c237842d7a7069d929fb2892dbfe85 (diff) | |
download | numpy-0d35127755ba6812e722a311bfab5e6523c444bb.tar.gz |
DOC: regex-assisted fixes of definition list formatting
Diffstat (limited to 'numpy')
-rw-r--r-- | numpy/core/arrayprint.py | 3 | ||||
-rw-r--r-- | numpy/lib/_iotools.py | 5 | ||||
-rw-r--r-- | numpy/lib/format.py | 2 | ||||
-rw-r--r-- | numpy/lib/npyio.py | 2 | ||||
-rw-r--r-- | numpy/lib/polynomial.py | 2 | ||||
-rw-r--r-- | numpy/ma/core.py | 4 | ||||
-rw-r--r-- | numpy/ma/extras.py | 2 | ||||
-rw-r--r-- | numpy/polynomial/polyutils.py | 2 |
8 files changed, 12 insertions, 10 deletions
diff --git a/numpy/core/arrayprint.py b/numpy/core/arrayprint.py index fa91a4799..17eeef0b3 100644 --- a/numpy/core/arrayprint.py +++ b/numpy/core/arrayprint.py @@ -399,7 +399,8 @@ def array2string(a, max_line_width=None, precision=None, Raises ------ - TypeError : if a callable in `formatter` does not return a string. + TypeError + if a callable in `formatter` does not return a string. See Also -------- diff --git a/numpy/lib/_iotools.py b/numpy/lib/_iotools.py index aa3744204..dc07c3cd9 100644 --- a/numpy/lib/_iotools.py +++ b/numpy/lib/_iotools.py @@ -87,7 +87,8 @@ def has_nested_fields(ndtype): Raises ------ - AttributeError : If `ndtype` does not have a `names` attribute. + AttributeError + If `ndtype` does not have a `names` attribute. Examples -------- @@ -267,7 +268,7 @@ class NameValidator(object): * If 'lower', field names are converted to lower case. The default value is True. - replace_space: '_', optional + replace_space : '_', optional Character(s) used in replacement of white spaces. Notes diff --git a/numpy/lib/format.py b/numpy/lib/format.py index 9a558f40c..724125f1d 100644 --- a/numpy/lib/format.py +++ b/numpy/lib/format.py @@ -311,7 +311,7 @@ def read_array_header_1_0(fp): Raises ------ - ValueError : + ValueError If the data is invalid. """ diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index ca410a24a..b6ae7ba01 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -283,7 +283,7 @@ def load(file, mmap_mode=None): file : file-like object or string The file to read. It must support ``seek()`` and ``read()`` methods. If the filename extension is ``.gz``, the file is first decompressed. - mmap_mode: {None, 'r+', 'r', 'w+', 'c'}, optional + mmap_mode : {None, 'r+', 'r', 'w+', 'c'}, optional If not None, then memory-map the file, using the given mode (see `numpy.memmap` for a detailed description of the modes). A memory-mapped array is kept on disk. However, it can be accessed diff --git a/numpy/lib/polynomial.py b/numpy/lib/polynomial.py index de83016e9..0720f7345 100644 --- a/numpy/lib/polynomial.py +++ b/numpy/lib/polynomial.py @@ -169,7 +169,7 @@ def roots(p): Raises ------ - ValueError : + ValueError When `p` cannot be converted to a rank-1 array. See also diff --git a/numpy/ma/core.py b/numpy/ma/core.py index 5ab12e219..5f3c33dcc 100644 --- a/numpy/ma/core.py +++ b/numpy/ma/core.py @@ -1530,7 +1530,7 @@ def make_mask_none(newshape, dtype=None): ---------- newshape : tuple A tuple indicating the shape of the mask. - dtype: {None, dtype}, optional + dtype : {None, dtype}, optional If None, use a MaskType instance. Otherwise, use a new datatype with the same fields as `dtype`, converted to boolean types. @@ -5650,7 +5650,7 @@ class mvoid(MaskedArray): Returns ------- - filled_void: + filled_void A `np.void` object See Also diff --git a/numpy/ma/extras.py b/numpy/ma/extras.py index 857d72249..279f1e7e4 100644 --- a/numpy/ma/extras.py +++ b/numpy/ma/extras.py @@ -1296,7 +1296,7 @@ def cov(x, y=None, rowvar=True, bias=False, allow_masked=True, ddof=None): Raises ------ - ValueError: + ValueError Raised if some values are missing and `allow_masked` is False. See Also diff --git a/numpy/polynomial/polyutils.py b/numpy/polynomial/polyutils.py index 8861328c4..d4490aafc 100644 --- a/numpy/polynomial/polyutils.py +++ b/numpy/polynomial/polyutils.py @@ -138,7 +138,7 @@ def as_series(alist, trim=True) : Raises ------ - ValueError : + ValueError Raised when `as_series` cannot convert its input to 1-d arrays, or at least one of the resulting arrays is empty. |