python / cpython

The Python programming language
https://www.python.org
Other
63.35k stars 30.34k forks source link

Incorrect reference names in asyncio.subprocess documentation #73313

Closed d94d1c66-2d7f-4e4c-848a-6c8d45a0cfbb closed 4 years ago

d94d1c66-2d7f-4e4c-848a-6c8d45a0cfbb commented 7 years ago
BPO 29127
Nosy @carlbordum, @aeros

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: ```python assignee = None closed_at = created_at = labels = ['docs'] title = 'Incorrect reference names in asyncio.subprocess documentation' updated_at = user = 'https://bugs.python.org/EricAhn' ``` bugs.python.org fields: ```python activity = actor = 'aeros' assignee = 'docs@python' closed = True closed_date = closer = 'aeros' components = ['Documentation'] creation = creator = 'Eric Ahn' dependencies = [] files = [] hgrepos = [] issue_num = 29127 keywords = [] message_count = 3.0 messages = ['284418', '377780', '377801'] nosy_count = 4.0 nosy_names = ['docs@python', 'Eric Ahn', 'carlbordum', 'aeros'] pr_nums = [] priority = 'normal' resolution = 'fixed' stage = 'resolved' status = 'closed' superseder = None type = None url = 'https://bugs.python.org/issue29127' versions = ['Python 3.6'] ```

d94d1c66-2d7f-4e4c-848a-6c8d45a0cfbb commented 7 years ago

On this page of the documentation https://docs.python.org/3/library/asyncio-subprocess.html it seems that some of the reference names are incorrect.

Namely, asyncio.subprocess.PIPE is referred to as asyncio.asyncio.subprocess.PIPE (along with STDOUT and DEVNULL), plus asyncio.subprocess.Process is referred to as asyncio.asyncio.subprocess.Process.

This is reflected in the permalinks as well as when one tries to reference these via intersphinx (which is how I discovered it; I was trying to link to this page and was failing).

739a9cce-c69d-4616-87ea-5110a32abb94 commented 4 years ago

I do not think this is the case any longer

aeros commented 4 years ago

I can confirm that both on the latest version of the docs (for 3.8) and for the version mentioned in the issue (3.6), the issue mentioned with asyncio.subprocess.PIPE is no longer present. (It was likely fixed in the asyncio documentation overhaul that happened within the last couple of years).

As a result, I'll proceed with closing this issue. Thanks for checking, Carl.