From 019f142169bfbf71bcd7d377b03cc5954381dc9a Mon Sep 17 00:00:00 2001 From: Jean Connelly Date: Wed, 6 Nov 2024 12:12:14 -0500 Subject: [PATCH] Update linspace step_max docs --- cxotime/cxotime.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/cxotime/cxotime.py b/cxotime/cxotime.py index 2298370..e67c287 100644 --- a/cxotime/cxotime.py +++ b/cxotime/cxotime.py @@ -190,6 +190,10 @@ def linspace( uniformly spaced by up to ``step_max``, and cover the time range from ``start`` to ``stop``. + Note that returned intervals may be larger than ``step_max`` by floating point error. + If calling code requires that all the intervals be less than a value, ``step_max`` should + be set to a value at least slightly smaller than the desired maximum value. + Parameters ---------- start : CxoTimeLike @@ -199,7 +203,7 @@ def linspace( num : int | None Number of time bins. step_max : u.Quantity (timelike) - Maximum time interval step.. Should be positive nonzero. + Maximum time interval step. Should be positive nonzero. Returns -------