Skip to content

Bad wording in the documentation of the time module #162314

Description

@hobler

Documentation URL

https://docs.python.org/3/library/time.html

Documentation

The descriptions of the functions monotonic, perf_counter, process_time, and thread_time start with "Return the value (in fractional seconds)". This should be changed to "Return the value (in seconds)". The term "fractional seconds" is ambiguous and rather refers to only the fractional part of a float, see https://stackoverflow.com/questions/8937708/what-is-a-fractional-second.

For a physics quantity like time it is quite natural to have float values, and this is also indicated in the documentation by the type hints for the return values.

Linked PRs

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions