[issue39135] time.get_clock_info() documentation still has 'clock' name
New submission from Michael Wayne Goodman <goodman.m.w@gmail.com>: 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. ---------- assignee: docs@python components: Documentation messages: 358879 nosy: docs@python, goodmami priority: normal severity: normal status: open title: time.get_clock_info() documentation still has 'clock' name versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Karthikeyan Singaravelan <tir.karthi@gmail.com> added the comment: 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 . ---------- keywords: +easy, newcomer friendly nosy: +xtreak _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Michael Wayne Goodman <goodman.m.w@gmail.com> added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Change by Michael Wayne Goodman <goodman.m.w@gmail.com>: ---------- keywords: +patch pull_requests: +17154 stage: -> patch review pull_request: https://github.com/python/cpython/pull/17709 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Benjamin Peterson <benjamin@python.org> added the comment: 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/91874bb07161bb481b6f5ea18ffafe69cb8... ---------- nosy: +benjamin.peterson resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Change by Benjamin Peterson <benjamin@python.org>: ---------- pull_requests: +17158 pull_request: https://github.com/python/cpython/pull/17713 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
Benjamin Peterson <benjamin@python.org> added the comment: 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/b9b92d34646d6a1fca120f98476912f5e4c... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39135> _______________________________________
participants (3)
-
Benjamin Peterson -
Karthikeyan Singaravelan
-
Michael Wayne Goodman