diff options
| author | Max Kellermeier <max.kellermeier@hotmail.de> | 2020-08-23 22:05:12 +0200 |
|---|---|---|
| committer | Max Kellermeier <max.kellermeier@hotmail.de> | 2020-08-23 22:05:12 +0200 |
| commit | a84b28afb9fdd0547148ba186d59fcaba9e82a8d (patch) | |
| tree | 963adb265ac309e48feb37906f5f5c90dd0256dc /numpy/lib/function_base.py | |
| parent | 7c56c83d39677deb00fc42e31a96a7118fe255a0 (diff) | |
| download | numpy-a84b28afb9fdd0547148ba186d59fcaba9e82a8d.tar.gz | |
Comment in docs on discontinuity in unwrap
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 41dec5e80..04b051973 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -1504,8 +1504,9 @@ def unwrap(p, discont=None, axis=-1, *, period=2*pi): p : array_like Input array. discont : float, optional - Maximum discontinuity between values, default is ``period/2``. - Values below ``period/2`` are treated as if they were ``period/2``. + Maximum discontinuity between values, default is ``period/2``. + Values below ``period/2`` are treated as if they were ``period/2``. To have an effect + different from the default, `discont` should be larger than ``period/2``. axis : int, optional Axis along which unwrap will operate, default is the last axis. period: float, optional |