classification
Title: Doc: Asyncio's Event documentation typo.
Type: enhancement Stage: resolved
Components: asyncio, Documentation Versions: Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, socketpair, tuxtimo, vstinner, yselivanov
Priority: normal Keywords: patch

Created on 2018-05-31 08:48 by socketpair, last changed 2018-10-19 23:36 by vstinner. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 7280 closed tuxtimo, 2018-05-31 10:48
Messages (7)
msg318270 - (view) Author: Марк Коренберг (socketpair) * Date: 2018-05-31 08:48
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.
msg318275 - (view) Author: Timo Furrer (tuxtimo) * Date: 2018-05-31 09:31
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 ;)
msg318276 - (view) Author: Марк Коренберг (socketpair) * Date: 2018-05-31 09:32
NO! it points to asyncio.wait() but should point to asyncio.Event.wait()
msg318277 - (view) Author: Timo Furrer (tuxtimo) * Date: 2018-05-31 09:50
Yes, sorry, my bad.
msg318278 - (view) Author: Timo Furrer (tuxtimo) * Date: 2018-05-31 09:51
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
msg318280 - (view) Author: Timo Furrer (tuxtimo) * Date: 2018-05-31 10:15
I'm working on a patch :)
msg328084 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2018-10-19 23:36
The asyncio documentation has been rewritten. It seems like the missing references issue is gone.
History
Date User Action Args
2018-10-19 23:36:03vstinnersetstatus: open -> closed

nosy: + vstinner
messages: + msg328084

resolution: fixed
stage: patch review -> resolved
2018-05-31 10:48:21tuxtimosetkeywords: + patch
stage: patch review
pull_requests: + pull_request6905
2018-05-31 10:15:47tuxtimosetmessages: + msg318280
2018-05-31 09:51:55tuxtimosetmessages: + msg318278
2018-05-31 09:50:23tuxtimosetmessages: + msg318277
2018-05-31 09:32:41socketpairsetmessages: + msg318276
2018-05-31 09:31:01tuxtimosetnosy: + tuxtimo
messages: + msg318275
2018-05-31 08:48:14socketpaircreate