Skip to content

Commit

Permalink
Update linspace step_max docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeanconn committed Nov 6, 2024
1 parent 5dcb3e7 commit 019f142
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion cxotime/cxotime.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
-------
Expand Down

0 comments on commit 019f142

Please sign in to comment.