The Wayback Machine - https://web.archive.org/web/20250611022155/https://github.com/python/cpython/pull/28029
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 7, 2021
Merged

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

merged 1 commit into from
Sep 7, 2021

Conversation

mattip
Copy link
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
@ambv ambv added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Sep 7, 2021
@miss-islington
Copy link
Contributor

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
Contributor

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

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

@bedevere-bot bedevere-bot removed needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Sep 7, 2021
@bedevere-bot
Copy link

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 <[email protected]>
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 <[email protected]>
@ambv
Copy link
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 <[email protected]>
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 <[email protected]>
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