Skip to content

DOC: remove documentation for non-existing socket class attributes#28029

Merged
ambv merged 1 commit into
python:mainfrom
mattip:if_nameindex
Sep 7, 2021
Merged

DOC: remove documentation for non-existing socket class attributes#28029
ambv merged 1 commit into
python:mainfrom
mattip:if_nameindex

Conversation

@mattip
Copy link
Copy Markdown
Contributor

@mattip mattip commented Aug 29, 2021

The module-level functions if_nameindex, if_nametoindex and if_indextoname were documented as existing on the class.

import socket
s = socket.socket()
s.if_nameindex()  # AttributeError
socket.if_nameindex()
# Prints the expected result

Does this qualify as a "small documentation fix" that needs no issue, or should I open a corresponding issue.

Note the documentation is a bit confusing since it is not clear that the socket prefix here refers to the module, not the object. The object docs start a few lines down. So the rst docs need no fixes.

@ambv ambv merged commit 34d82ce into python:main Sep 7, 2021
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Sep 7, 2021

Thanks @mattip for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Sep 7, 2021

Thanks @mattip for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Sep 7, 2021

GH-28221 is a backport of this pull request to the 3.9 branch.

@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Sep 7, 2021

GH-28222 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 7, 2021
@mattip @miss-islington
Remove documentation for non-existing socket class attributes (python…
4910fd7 
…GH-28029)

The functions in question are available on the module-level only.
(cherry picked from commit 34d82ce)

Co-authored-by: Matti Picus <matti.picus@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 7, 2021
@mattip @miss-islington
Remove documentation for non-existing socket class attributes (python…
b0c4507 
…GH-28029)

The functions in question are available on the module-level only.
(cherry picked from commit 34d82ce)

Co-authored-by: Matti Picus <matti.picus@gmail.com>
@ambv
Copy link
Copy Markdown
Contributor

ambv commented Sep 7, 2021

Thanks for the fix, Matti! ✨ 🍰 ✨

ambv pushed a commit that referenced this pull request Sep 7, 2021
@miss-islington @mattip
Remove documentation for non-existing socket class attributes (GH-28029…
d9b7d42 
…) (GH-28221)

The functions in question are available on the module-level only.
(cherry picked from commit 34d82ce)

Co-authored-by: Matti Picus <matti.picus@gmail.com>
miss-islington added a commit that referenced this pull request Sep 7, 2021
@miss-islington @mattip
Remove documentation for non-existing socket class attributes (GH-28029)
a272ffe 
The functions in question are available on the module-level only.
(cherry picked from commit 34d82ce)

Co-authored-by: Matti Picus <matti.picus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mattip @miss-islington @bedevere-bot @ambv @the-knights-who-say-ni