Update monotonic function docstring for clarity#10764
Merged
dhalbert merged 2 commits intoadafruit:10.0.xfrom Dec 29, 2025
Merged
Update monotonic function docstring for clarity#10764dhalbert merged 2 commits intoadafruit:10.0.xfrom
dhalbert merged 2 commits intoadafruit:10.0.xfrom
Conversation
Clarify the return value of the monotonic function to specify it returns fractional seconds. looking at cpython's time.monotonic() documentation, one sees in the first line "Return the value (in fractional seconds) of a monotonic clock" - I would have expected a similar introduction when reading that for circuitpython at https://docs.circuitpython.org/en/latest/shared-bindings/time/ I see there is a fall back that says "For more information, refer to the original CPython documentation" but would it have hurt to have mention that the units of the float returned by time.monotomic was in seconds? ( there are 7 mentions of millisecond(s),
dhalbert
approved these changes
Dec 24, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify the return value of the monotonic function to specify it returns fractional seconds.
looking at cpython's time.monotonic() documentation, one sees in the first line "Return the value (in fractional seconds) of a monotonic clock" -
I would have expected a similar introduction when reading that for circuitpython at https://docs.circuitpython.org/en/latest/shared-bindings/time/
I see there is a fall back that says "For more information, refer to the original CPython documentation"
but would it have hurt to have mention that the units of the float returned by time.monotomic was in seconds? ( there are 7 mentions of millisecond(s),