Skip to content

Conversation

@d-c-d
Copy link

@d-c-d d-c-d commented Dec 24, 2025

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),


d-c-d and others added 2 commits December 24, 2025 13:28
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),
Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I changed the wording a bit, to remove the bold on seconds (because time almost always deals in seconds, and to clarify in the next paragraph. How's that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants