summaryrefslogtreecommitdiff
path: root/numpy/lib/function_base.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/lib/function_base.py')
-rw-r--r--numpy/lib/function_base.py5
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