Skip to content

Commit

Permalink
bpo-36895: Undocument removed time.clock (GH-13286)
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau authored and vstinner committed May 13, 2019
1 parent b1dfcad commit b6a09ae
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 24 deletions.
24 changes: 0 additions & 24 deletions Doc/library/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,30 +136,6 @@ Functions
Unlike the C function of the same name, :func:`asctime` does not add a
trailing newline.


.. function:: clock()

.. index::
single: CPU time
single: processor time
single: benchmarking

On Unix, return the current processor time as a floating point number expressed
in seconds. The precision, and in fact the very definition of the meaning of
"processor time", depends on that of the C function of the same name.

On Windows, this function returns wall-clock seconds elapsed since the first
call to this function, as a floating point number, based on the Win32 function
:c:func:`QueryPerformanceCounter`. The resolution is typically better than one
microsecond.

.. availability:: Windows, Unix. Not available on VxWorks.

.. deprecated-removed:: 3.3 3.8
The behaviour of this function depends on the platform: use
:func:`perf_counter` or :func:`process_time` instead, depending on your
requirements, to have a well defined behaviour.

.. function:: pthread_getcpuclockid(thread_id)

Return the *clk_id* of the thread-specific CPU-time clock for the specified *thread_id*.
Expand Down
4 changes: 4 additions & 0 deletions Doc/whatsnew/3.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,10 @@ The following features and APIs have been removed from Python 3.8:
* The function :func:`platform.popen` has been removed, it was deprecated since
Python 3.3: use :func:`os.popen` instead.

* The function :func:`time.clock` has been removed, it was deprecated since Python
3.3: use :func:`time.perf_counter` or :func:`time.process_time` instead, depending
on your requirements, to have a well defined behavior.

* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
to help eliminate confusion as to what Python interpreter the ``pyvenv``
script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Expand Down

0 comments on commit b6a09ae

Please sign in to comment.