summaryrefslogtreecommitdiff
path: root/numpy/lib/arraypad.py
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2019-03-19 09:56:48 +0200
committerGitHub <noreply@github.com>2019-03-19 09:56:48 +0200
commit0c3c04ebc1f9b038ebc75b1dc0b46437accb3e7f (patch)
tree12e539af4a9500f21888f7ea3b34361fd2c852b5 /numpy/lib/arraypad.py
parent19eb971dc0baf84c3fabfc8aef77edef56587bff (diff)
parent7394759e9d4159fcd1b39c7fed06f14bf5681a1b (diff)
downloadnumpy-0c3c04ebc1f9b038ebc75b1dc0b46437accb3e7f.tar.gz
Merge pull request #13117 from kshyatt/ksh/pad
DOC: Fix arg type for np.pad, fix #9489
Diffstat (limited to 'numpy/lib/arraypad.py')
-rw-r--r--numpy/lib/arraypad.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/numpy/lib/arraypad.py b/numpy/lib/arraypad.py
index 630767dc5..66f21bfca 100644
--- a/numpy/lib/arraypad.py
+++ b/numpy/lib/arraypad.py
@@ -1026,31 +1026,31 @@ def pad(array, pad_width, mode='constant', **kwargs):
length for all axes.
Default is ``None``, to use the entire axis.
- constant_values : sequence or int, optional
+ constant_values : sequence or scalar, optional
Used in 'constant'. The values to set the padded values for each
axis.
- ((before_1, after_1), ... (before_N, after_N)) unique pad constants
+ ``((before_1, after_1), ... (before_N, after_N))`` unique pad constants
for each axis.
- ((before, after),) yields same before and after constants for each
+ ``((before, after),)`` yields same before and after constants for each
axis.
- (constant,) or int is a shortcut for before = after = constant for
+ ``(constant,)`` or ``constant`` is a shortcut for ``before = after = constant`` for
all axes.
Default is 0.
- end_values : sequence or int, optional
+ end_values : sequence or scalar, 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.
- ((before_1, after_1), ... (before_N, after_N)) unique end values
+ ``((before_1, after_1), ... (before_N, after_N))`` unique end values
for each axis.
- ((before, after),) yields same before and after end values for each
+ ``((before, after),)`` yields same before and after end values for each
axis.
- (constant,) or int is a shortcut for before = after = end value for
+ ``(constant,)`` or ``constant`` is a shortcut for ``before = after = constant`` for
all axes.
Default is 0.