Typo in asyncio-eventloop.rst, time() link is wrong

[mgrandi]

BPO	22808
Nosy	@gvanrossum, @vstinner, @berkerpeksag, @1st1, @mgrandi
Files	markgrandi_asyncio-eventloop.rst.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-11-07.17:52:32.557>
created_at = <Date 2014-11-06.21:07:10.402>
labels = ['type-feature', 'docs', 'expert-asyncio']
title = 'Typo in asyncio-eventloop.rst, time() link is wrong'
updated_at = <Date 2014-11-07.17:52:32.556>
user = 'https://github.com/mgrandi'

bugs.python.org fields:

activity = <Date 2014-11-07.17:52:32.556>
actor = 'berker.peksag'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-11-07.17:52:32.557>
closer = 'berker.peksag'
components = ['Documentation', 'asyncio']
creation = <Date 2014-11-06.21:07:10.402>
creator = 'markgrandi'
dependencies = []
files = ['37141']
hgrepos = []
issue_num = 22808
keywords = ['patch']
message_count = 4.0
messages = ['230764', '230769', '230820', '230821']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'vstinner', 'docs@python', 'python-dev', 'berker.peksag', 'yselivanov', 'markgrandi']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22808'
versions = ['Python 3.4', 'Python 3.5']

[mgrandi]

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.

[gvanrossum]

LG, can someone commit this? Should be backported to the 3.4 docs as well.

[python-dev]

New changeset 8b1d8fcb494b by Berker Peksag in branch '3.4':
Issue bpo-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 bpo-22808: Link to the correct time method in BaseEventLoop.call_at().
https://hg.python.org/cpython/rev/98f4bc1332c9

[berkerpeksag]

Committed. Thanks for the patch, Mark.