From a84b28afb9fdd0547148ba186d59fcaba9e82a8d Mon Sep 17 00:00:00 2001 From: Max Kellermeier Date: Sun, 23 Aug 2020 22:05:12 +0200 Subject: Comment in docs on discontinuity in unwrap --- numpy/lib/function_base.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'numpy/lib/function_base.py') 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 -- cgit v1.2.1