Doc: Asyncio's Event documentation typo.

[socketpair]

BPO	33708
Nosy	@vstinner, @asvetlov, @socketpair, @1st1, @timofurrer
PRs	bpo-33708: Fix method reference links in asyncio.Event and asyncio.Condition docs #7280

^{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 2018-10-19.23:36:03.164>
created_at = <Date 2018-05-31.08:48:14.614>
labels = ['type-feature', '3.8', 'docs', 'expert-asyncio']
title = "Doc: Asyncio's Event documentation typo."
updated_at = <Date 2018-10-19.23:36:03.162>
user = 'https://github.com/socketpair'

bugs.python.org fields:

activity = <Date 2018-10-19.23:36:03.162>
actor = 'vstinner'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-10-19.23:36:03.164>
closer = 'vstinner'
components = ['Documentation', 'asyncio']
creation = <Date 2018-05-31.08:48:14.614>
creator = 'socketpair'
dependencies = []
files = []
hgrepos = []
issue_num = 33708
keywords = ['patch']
message_count = 7.0
messages = ['318270', '318275', '318276', '318277', '318278', '318280', '328084']
nosy_count = 6.0
nosy_names = ['vstinner', 'asvetlov', 'docs@python', 'socketpair', 'yselivanov', 'tuxtimo']
pr_nums = ['7280']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33708'
versions = ['Python 3.8']

[socketpair]

https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event :

Class implementing event objects. An event manages a flag that can be set to true with the set() method and reset to false with the clear() method. The -----> wait() <----- method blocks until the flag is true. The flag is initially false.

this link points to wrong place.

[timofurrer]

It seems like it's pointing to the correct location, it's just that depending on the size of your screen the "wait" section is too far to the bottom and therefore it can't quite scroll to the heading of the wait heading so that it's on top of your screen ;)

[socketpair]

NO! it points to asyncio.wait() but should point to asyncio.Event.wait()

[timofurrer]

Yes, sorry, my bad.

[timofurrer]

The link to the set method is also wrong. It points to https://docs.python.org/3/library/stdtypes.html#set instead of https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event.set

[timofurrer]

I'm working on a patch :)

[vstinner]

The asyncio documentation has been rewritten. It seems like the missing references issue is gone.