This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Typo in asyncio-eventloop.rst, time() link is wrong
Type: enhancement Stage: resolved
Components: asyncio, Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: berker.peksag, docs@python, gvanrossum, markgrandi, python-dev, vstinner, yselivanov
Priority: normal Keywords: patch

Created on 2014-11-06 21:07 by markgrandi, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
markgrandi_asyncio-eventloop.rst.patch markgrandi, 2014-11-06 21:07 review
Messages (4)
msg230764 - (view) Author: Mark Grandi (markgrandi) * Date: 2014-11-06 21:07
In the asyncio documentation, specifically asyncio-eventloop.rst, in the description for BaseEventLoop.call_at(), it has:

   Arrange for the *callback* to be called at the given absolute timestamp *when* (an int or float), using the same time reference as :meth:`time`.

This links to the time module's time.time() method, which is incorrect as well as confusing, as the event loop's clock is NOT the same as time.time(), and it even says so on the top of the 'delayed calls' section

According the python documentation guide, it should have a period before it to make it refer to a method that is within the same module. I however decided to change it to `BaseEventLoop.time()`, because when i  see the text 'time()', even if it links to the right method, still makes me think of time.time(), which is again confusing and generally incorrect. 

Attached is a patch file, its a trivial change, but i did regenerate the docs and confirmed that it works, and clicking the link takes you to the right method in the page.
msg230769 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2014-11-06 23:48
LG, can someone commit this? Should be backported to the 3.4 docs as well.
msg230820 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-11-07 17:51
New changeset 8b1d8fcb494b by Berker Peksag in branch '3.4':
Issue #22808: Link to the correct time method in BaseEventLoop.call_at().
https://hg.python.org/cpython/rev/8b1d8fcb494b

New changeset 98f4bc1332c9 by Berker Peksag in branch 'default':
Issue #22808: Link to the correct time method in BaseEventLoop.call_at().
https://hg.python.org/cpython/rev/98f4bc1332c9
msg230821 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2014-11-07 17:52
Committed. Thanks for the patch, Mark.
History
Date User Action Args
2022-04-11 14:58:09adminsetgithub: 66997
2014-11-07 17:52:32berker.peksagsetstatus: open -> closed

nosy: + berker.peksag
messages: + msg230821

resolution: fixed
stage: patch review -> resolved
2014-11-07 17:51:44python-devsetnosy: + python-dev
messages: + msg230820
2014-11-06 23:48:44gvanrossumsetmessages: + msg230769
2014-11-06 23:46:21berker.peksagsetnosy: + yselivanov, vstinner, gvanrossum
stage: patch review

components: + asyncio
versions: + Python 3.5
2014-11-06 21:07:10markgrandicreate