◐ Shell
reader mode source ↗
Skip to content

GH-101100: Fix reference warnings for socket methods#110114

Merged
hugovk merged 10 commits into
python:mainfrom
AA-Turner:docs/refwarn/socket
Nov 27, 2023
Merged

GH-101100: Fix reference warnings for socket methods#110114
hugovk merged 10 commits into
python:mainfrom
AA-Turner:docs/refwarn/socket

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Sep 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 29, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Sep 29, 2023
Open
serhiy-storchaka
serhiy-storchaka reviewed Sep 29, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

I think that in all cases where it refers to socket() as a function, it should keep :func: role.

11 hidden items Load more…
serhiy-storchaka
serhiy-storchaka reviewed Oct 22, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

I think that the problem is that if you use a reference starting with ., Sphinx switches in more strict mode that checks the role type, so :func:`.socket` does not find the class declaration. But :func:`socket.socket` may work.

@hugovk

hugovk commented Oct 31, 2023

Copy link
Copy Markdown
Member

@AA-Turner Please could you resolve the conflicts? Then I think we're ready to merge.

serhiy-storchaka
serhiy-storchaka approved these changes Nov 27, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

I restored the use of the .. class:: directive for socket. It fixes rendering for "the socket constructor". The :func: references work when specify the full qualified name.

Also fixed references for few more methods.

@hugovk hugovk merged commit ffe1b2d into python:main Nov 27, 2023
@miss-islington-app

miss-islington-app Bot commented Nov 27, 2023

Copy link
Copy Markdown

Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 27, 2023
@AA-Turner @serhiy-storchaka @miss-islington
pythonGH-101100: Fix reference warnings for socket methods (pytho… …
67b8277 
…nGH-110114)

(cherry picked from commit ffe1b2d)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 27, 2023
@AA-Turner @serhiy-storchaka @miss-islington
pythonGH-101100: Fix reference warnings for socket methods (pytho… …
27ab3a2 
…nGH-110114)

(cherry picked from commit ffe1b2d)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app

bedevere-app Bot commented Nov 27, 2023

Copy link
Copy Markdown

GH-112455 is a backport of this pull request to the 3.12 branch.

@bedevere-app

bedevere-app Bot commented Nov 27, 2023

Copy link
Copy Markdown

GH-112456 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Nov 27, 2023
hugovk pushed a commit that referenced this pull request Nov 27, 2023
@miss-islington @AA-Turner @serhiy-storchaka
[3.11] GH-101100: Fix reference warnings for socket methods (GH-1… …
62e430a 
…10114) (#112456)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk pushed a commit that referenced this pull request Nov 27, 2023
@miss-islington @AA-Turner @serhiy-storchaka
[3.12] GH-101100: Fix reference warnings for socket methods (GH-1… …
a2ed553 
…10114) (#112455)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AA-Turner @serhiy-storchaka @aisk
pythonGH-101100: Fix reference warnings for socket methods (pytho… …
9f361f1 
…n#110114)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AA-Turner @serhiy-storchaka @Glyphack
pythonGH-101100: Fix reference warnings for socket methods (pytho… …
3bf5ce5 
…n#110114)

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

Reviewers

@hugovk hugovk hugovk approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@ezio-melotti ezio-melotti

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@AA-Turner @hugovk @serhiy-storchaka @ezio-melotti