classification
Title: time.get_clock_info() documentation still has 'clock' name
Type: Stage: resolved
Components: Documentation Versions: Python 3.9, Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: benjamin.peterson, docs@python, goodmami, xtreak
Priority: normal Keywords: easy, newcomer friendly, patch

Created on 2019-12-26 07:12 by goodmami, last changed 2019-12-27 03:07 by benjamin.peterson. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 17709 merged goodmami, 2019-12-27 02:13
PR 17713 merged benjamin.peterson, 2019-12-27 03:02
Messages (5)
msg358879 - (view) Author: Michael Wayne Goodman (goodmami) * Date: 2019-12-26 07:12
The documentation for Python 3.8 and higher still refer to 'clock' as an accepted 'name' argument for time.get_clock_info() that returns a namespace readable by time.clock(), despite time.clock() being removed since Python 3.8.

See the first bullet point in the function documentation: https://docs.python.org/3.8/library/time.html#time.get_clock_info

In Python 3.8, calling time.get_clock_info('clock') raises "ValueError: unknown clock", so it seems the bug is only in the documentation.
msg358880 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2019-12-26 07:42
Thanks for the report. Would you like to propose a PR? The relevant file is at https://github.com/python/cpython/blob/master/Doc/library/time.rst .
msg358883 - (view) Author: Michael Wayne Goodman (goodmami) * Date: 2019-12-26 08:45
Sure, no problem. I've just signed the CLA and forked the code. I'll wait a day for the CLA check to clear then submit.
msg358898 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2019-12-27 03:01
New changeset 91874bb07161bb481b6f5ea18ffafe69cb8cac30 by Benjamin Peterson (Michael Wayne Goodman) in branch 'master':
closes bpo-39135: Remove 'time.clock()' mention in docs. (GH17709)
https://github.com/python/cpython/commit/91874bb07161bb481b6f5ea18ffafe69cb8cac30
msg358899 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2019-12-27 03:07
New changeset b9b92d34646d6a1fca120f98476912f5e4ca7f34 by Benjamin Peterson in branch '3.8':
[3.8] closes bpo-39135: Remove 'time.clock()' mention in docs. (GH-17713)
https://github.com/python/cpython/commit/b9b92d34646d6a1fca120f98476912f5e4ca7f34
History
Date User Action Args
2019-12-27 03:07:27benjamin.petersonsetmessages: + msg358899
2019-12-27 03:02:10benjamin.petersonsetpull_requests: + pull_request17158
2019-12-27 03:01:15benjamin.petersonsetstatus: open -> closed

nosy: + benjamin.peterson
messages: + msg358898

resolution: fixed
stage: patch review -> resolved
2019-12-27 02:13:47goodmamisetkeywords: + patch
stage: patch review
pull_requests: + pull_request17154
2019-12-26 08:45:03goodmamisetmessages: + msg358883
2019-12-26 07:42:46xtreaksetkeywords: + easy, newcomer friendly
nosy: + xtreak
messages: + msg358880

2019-12-26 07:12:12goodmamicreate