Skip to content

Commit 704b718

Browse files
authored
Merge pull request #47 from sot/linspace-docs
Update linspace step_max docs
2 parents 5dcb3e7 + 019f142 commit 704b718

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

cxotime/cxotime.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,10 @@ def linspace(
190190
uniformly spaced by up to ``step_max``, and cover the time
191191
range from ``start`` to ``stop``.
192192
193+
Note that returned intervals may be larger than ``step_max`` by floating point error.
194+
If calling code requires that all the intervals be less than a value, ``step_max`` should
195+
be set to a value at least slightly smaller than the desired maximum value.
196+
193197
Parameters
194198
----------
195199
start : CxoTimeLike
@@ -199,7 +203,7 @@ def linspace(
199203
num : int | None
200204
Number of time bins.
201205
step_max : u.Quantity (timelike)
202-
Maximum time interval step.. Should be positive nonzero.
206+
Maximum time interval step. Should be positive nonzero.
203207
204208
Returns
205209
-------

0 commit comments

Comments
 (0)