diff options
author | Katharine Hyatt <khyatt@flatironinstitute.org> | 2019-03-14 10:01:58 -0400 |
---|---|---|
committer | Katharine Hyatt <khyatt@flatironinstitute.org> | 2019-03-14 10:01:58 -0400 |
commit | 7394759e9d4159fcd1b39c7fed06f14bf5681a1b (patch) | |
tree | 4d1976d18d128c1701eb10dee9108bd7b5e5ec8d /numpy/lib/arraypad.py | |
parent | 763cb87bfe47fdd5efed59e909ee4e4e8ae6b36b (diff) | |
download | numpy-7394759e9d4159fcd1b39c7fed06f14bf5681a1b.tar.gz |
Update parameter description for constant and end values
Diffstat (limited to 'numpy/lib/arraypad.py')
-rw-r--r-- | numpy/lib/arraypad.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/numpy/lib/arraypad.py b/numpy/lib/arraypad.py index 2ff12eadd..c97d129a9 100644 --- a/numpy/lib/arraypad.py +++ b/numpy/lib/arraypad.py @@ -1030,13 +1030,13 @@ def pad(array, pad_width, mode, **kwargs): 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. @@ -1044,13 +1044,13 @@ def pad(array, pad_width, mode, **kwargs): 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. |