Skip to content

[docs] Use full names for time units #28611

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.

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

Merged
merged 1 commit into from
Sep 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/library/asyncio-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When the debug mode is enabled:
* The execution time of the I/O selector is logged if it takes too long to
perform an I/O operation.

* Callbacks taking longer than 100ms are logged. The
* Callbacks taking longer than 100 milliseconds are logged. The
:attr:`loop.slow_callback_duration` attribute can be used to set the
minimum execution duration in seconds that is considered "slow".

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/asyncio-platforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ All event loops on Windows do not support the following methods:
methods are not supported.

The resolution of the monotonic clock on Windows is usually around 15.6
msec. The best resolution is 0.5 msec. The resolution depends on the
milliseconds. The best resolution is 0.5 milliseconds. The resolution depends on the
hardware (availability of `HPET
<https://en.wikipedia.org/wiki/High_Precision_Event_Timer>`_) and on the
Windows configuration.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/curses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ The module :mod:`curses` defines the following functions:

Set the maximum time in milliseconds that can elapse between press and release
events in order for them to be recognized as a click, and return the previous
interval value. The default value is 200 msec, or one fifth of a second.
interval value. The default value is 200 milliseconds, or one fifth of a second.


.. function:: mousemask(mousemask)
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/multiprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ For example::
multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
print([res.get(timeout=1) for res in multiple_results])

# make a single worker sleep for 10 secs
# make a single worker sleep for 10 seconds
res = pool.apply_async(time.sleep, (10,))
try:
print(res.get(timeout=1))
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -366,11 +366,11 @@ Functions

Unix implementation:

* Use ``clock_nanosleep()`` if available (resolution: 1 ns);
* Or use ``nanosleep()`` if available (resolution: 1 ns);
* Or use ``select()`` (resolution: 1 us).
* Use ``clock_nanosleep()`` if available (resolution: 1 nanosecond);
* Or use ``nanosleep()`` if available (resolution: 1 nanosecond);
* Or use ``select()`` (resolution: 1 microsecond).

On Windows, a waitable timer is used (resolution: 100 ns). If *secs* is
On Windows, a waitable timer is used (resolution: 100 nanosecond). If *secs* is
zero, ``Sleep(0)`` is used.

.. versionchanged:: 3.11
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/timeit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Where the following options are understood:

.. cmdoption:: -u, --unit=U

specify a time unit for timer output; can select nsec, usec, msec, or sec
specify a time unit for timer output; can select ``nsec``, ``usec``, ``msec``, or ``sec``

.. versionadded:: 3.5

Expand Down
10 changes: 5 additions & 5 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,14 +243,14 @@ time
----

* On Unix, :func:`time.sleep` now uses the ``clock_nanosleep()`` or
``nanosleep()`` function, if available, which has a resolution of 1 ns
(10\ :sup:`-9` sec), rather than using ``select()`` which has a resolution
of 1 us (10\ :sup:`-6` sec).
``nanosleep()`` function, if available, which has a resolution of 1 nanosecond
(10\ :sup:`-9` seconds), rather than using ``select()`` which has a resolution
of 1 microsecond (10\ :sup:`-6` seconds).
(Contributed by Livius and Victor Stinner in :issue:`21302`.)

* On Windows, :func:`time.sleep` now uses a waitable timer which has a
resolution of 100 ns (10\ :sup:`-7` sec). Previously, it had a solution of 1 ms
(10\ :sup:`-3` sec).
resolution of 100 nanoseconds (10\ :sup:`-7` seconds). Previously, it had
a resolution of 1 millisecond (10\ :sup:`-3` seconds).
(Contributed by Livius and Victor Stinner in :issue:`21302`.)

unicodedata
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ time

On AIX, :func:`~time.thread_time` is now implemented with ``thread_cputime()``
which has nanosecond resolution, rather than
``clock_gettime(CLOCK_THREAD_CPUTIME_ID)`` which has a resolution of 10 ms.
``clock_gettime(CLOCK_THREAD_CPUTIME_ID)`` which has a resolution of 10 milliseconds.
(Contributed by Batuhan Taskaya in :issue:`40192`)

sys
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.10.0a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -786,7 +786,7 @@ Skip some asyncio tests on VxWorks.
.. nonce: uzwlF_
.. section: Tests

Enhance ``test_select.test_select()``: it now takes 500 ms rather than 10
Enhance ``test_select.test_select()``: it now takes 500 milliseconds rather than 10
seconds. Use Python rather than a shell to make the test more portable.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.7.0a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ match.
.. nonce: uxVOpk
.. section: Library

Abort asyncio SSLProtocol connection if handshake not complete within 10s
Abort asyncio SSLProtocol connection if handshake not complete within 10 seconds.

..

Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.9.0b1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ than alphabetical.

On AIX, :func:`~time.thread_time` is now implemented with
``thread_cputime()`` which has nanosecond resolution, rather than
``clock_gettime(CLOCK_THREAD_CPUTIME_ID)`` which has a resolution of 10 ms.
``clock_gettime(CLOCK_THREAD_CPUTIME_ID)`` which has a resolution of 10 milliseconds.
Patch by Batuhan Taskaya.

..
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
On Windows, :func:`time.sleep` now uses a waitable timer which has a resolution
of 100 ns (10\ :sup:`-7` sec). Previously, it had a solution of 1 ms (10\ :sup:`-3` sec).
of 100 nanoseconds (10\ :sup:`-7` seconds). Previously, it had a resolution of
1 millisecond (10\ :sup:`-3` seconds).
Patch by Livius and Victor Stinner.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Fix 16ms jitter when using timeouts in :mod:`threading`, such as with :meth:`threading.Lock.acquire` or :meth:`threading.Condition.wait`.
Fix 16 milliseconds jitter when using timeouts in :mod:`threading`, such as with :meth:`threading.Lock.acquire` or :meth:`threading.Condition.wait`.