diff options
author | Thomas A Caswell <tcaswell@gmail.com> | 2014-12-09 18:19:32 -0500 |
---|---|---|
committer | Thomas A Caswell <tcaswell@bnl.gov> | 2014-12-12 14:00:39 -0500 |
commit | 93ee10ef98936e1fa5386836fd5b34b4b6e4bb68 (patch) | |
tree | c884b1d3fb8802c8164545246707ed53f7b773f1 /numpy/lib/arraypad.py | |
parent | 48b61ec8c4b6e81100d96b3ab854947dd6ab1f64 (diff) | |
download | numpy-93ee10ef98936e1fa5386836fd5b34b4b6e4bb68.tar.gz |
DOC : do not abuse enum markup
- {ndarray, bool} -> ndarray or bool
- {int, array of ints} -> int or array of ints
- {str, function} -> str or function
- {sequnce, int} -> sequence or int
- {array_like, poly1d} -> array_like or poly1d
- {None, list of `m` scalars, scalar} -> list of `m` scalars or scalar
Diffstat (limited to 'numpy/lib/arraypad.py')
-rw-r--r-- | numpy/lib/arraypad.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/numpy/lib/arraypad.py b/numpy/lib/arraypad.py index bbfdce794..a48199a82 100644 --- a/numpy/lib/arraypad.py +++ b/numpy/lib/arraypad.py @@ -1105,7 +1105,7 @@ def pad(array, pad_width, mode=None, **kwargs): ((before, after),) yields same before and after pad for each axis. (pad,) or int is a shortcut for before = after = pad width for all axes. - mode : {str, function} + mode : str or function One of the following string values or a user supplied function. 'constant' @@ -1140,7 +1140,7 @@ def pad(array, pad_width, mode=None, **kwargs): end values are used to pad the beginning. <function> Padding function, see Notes. - stat_length : {sequence, int}, optional + stat_length : sequence or int, optional Used in 'maximum', 'mean', 'median', and 'minimum'. Number of values at edge of each axis used to calculate the statistic value. @@ -1154,7 +1154,7 @@ def pad(array, pad_width, mode=None, **kwargs): length for all axes. Default is ``None``, to use the entire axis. - constant_values : {sequence, int}, optional + constant_values : sequence or int, optional Used in 'constant'. The values to set the padded values for each axis. @@ -1168,7 +1168,7 @@ def pad(array, pad_width, mode=None, **kwargs): all axes. Default is 0. - end_values : {sequence, int}, optional + end_values : sequence or int, optional Used in 'linear_ramp'. The values used for the ending value of the linear_ramp and that will form the edge of the padded array. @@ -1182,7 +1182,7 @@ def pad(array, pad_width, mode=None, **kwargs): all axes. Default is 0. - reflect_type : str {'even', 'odd'}, optional + reflect_type : {'even', 'odd'}, optional Used in 'reflect', and 'symmetric'. The 'even' style is the default with an unaltered reflection around the edge value. For the 'odd' style, the extented part of the array is created by |