8000 gh-126745: Fixup Docu time.rst by dbstf · Pull Request #126744 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-126745: Fixup Docu time.rst #126744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

gh-126745: Fixup Docu time.rst #126744

wants to merge 2 commits into from

Conversation

dbstf
Copy link
@dbstf dbstf commented Nov 12, 2024 •
edited by bedevere-app bot
Loading
  • On Windows, the .time function now uses GetSystemTimePreciseAsFileTime() [--> 1 microsecond resolution] instead of GetSystemTimeAsFileTime() [--> 15.625 millisecond resolution].
  • On Windows The .monotonic functions now use the same clock as the .perf_counter functions, not vice versa. The .perf_counter functions previously already used QueryPerformanceCounter() + QueryPerformanceFrequency() [--> 1 microsecond resolution], whereas the .monotonic functions used GetTickCount64() [--> 15.625 millisecond resolution].

📚 Documentation preview 📚: https://cpython-previews--126744.org.readthedocs.build/

@dbstf
Fixup Docu time.rst
f1d7dfd 
- On Windows, the .time function now uses GetSystemTimePreciseAsFileTime() [--> 1 microsecond resolution] instead of GetSystemTimeAsFileTime() [--> 15.625 millisecond resolution].
- On Windows The .monotonic functions now use the same clock as the .perf_counter functions, not vice versa. The .perf_counter functions previously already used QueryPerformanceCounter() + QueryPerformanceFrequency() [--> 1 microsecond resolution], whereas the .monotonic functions used GetTickCount64() [--> 15.625 millisecond resolution].
@ghost
Copy link
ghost commented Nov 12, 2024 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Nov 12, 2024
@dbstf dbstf changed the title Fixup Docu time.rst gh-126745: Fixup Docu time.rst Nov 12, 2024
@bedevere-app bedevere-app bot mentioned this pull request Nov 12, 2024
Closed
@picnixz picnixz added the needs backport to 3.13 bugs and security fixes label Nov 12, 2024
vadmium
vadmium reviewed Nov 17, 2024
View reviewed changes
Doc/library/time.rst
.. impl-detail::

On CPython, use the same clock as :func:`time.perf_counter` and is a
monotonic clock, i.e. a clock that cannot go backwards.
Copy link
Member

Choose a reason for hiding this comment

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

This makes more sense under perf_counter were it was. All monotonic function should always be monotonic, by definition.

Doc/library/time.rst
@@ -307,13 +312,21 @@ Functions
.. versionchanged:: 3.10
On macOS, the function is now system-wide.

.. versionchanged:: 3.13
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`

This comment was marked as resolved.

Sign in to view

Doc/library/time.rst
Comment on lines +316 to +317
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`
now call ``QueryPerformanceCounter()`` which has a resolution of 1 microsecond,
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`
now call ``QueryPerformanceCounter()`` which has a resolution of 1 microsecond,
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`
now calls ``QueryPerformanceCounter()`` which has a resolution of 1 microsecond,

Doc/library/time.rst
* Call ``clock_gettime(CLOCK_REALTIME)`` if available.
* Otherwise, call ``gettimeofday()``.

Use :func:`time_ns` to avoid the precision loss caused by the :class:`float`
type.

.. versionchanged:: 3.13
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
.. versionchanged:: 3.13
.. versionchanged:: 3.13

Suspect the mixed indentation is screwing it up

vadmium
vadmium reviewed Nov 17, 2024
View reviewed changes
Doc/library/time.rst
@@ -307,13 +312,21 @@ Functions
.. versionchanged:: 3.10
On macOS, the function is now system-wide.

.. versionchanged:: 3.13
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Use the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`
The function now uses the same clock as :func:`time.perf_counter`. On Windows, :func:`monotonic`

@dbstf dbstf closed this by deleting the head repository Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vadmium vadmium vadmium left review comments

@pganssle pganssle Awaiting requested review from pganssle pganssle is a code owner

@abalkin abalkin Awaiting requested review from abalkin abalkin is a code owner

Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dbstf @vadmium @picnixz
0