Skip to content

gh-104882: Docs: fix description of relationship between socket.getblocking() and socket.gettimeout() - #105026

Merged
AlexWaygood merged 3 commits into
python:mainfrom
joegeisbauer-ce:fix-issue-104882
Jun 4, 2023
Merged

gh-104882: Docs: fix description of relationship between socket.getblocking() and socket.gettimeout()#105026
AlexWaygood merged 3 commits into
python:mainfrom
joegeisbauer-ce:fix-issue-104882

Conversation

@joegeisbauer-ce

@joegeisbauer-cejoegeisbauer-ce commented May 27, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown

@joegeisbauer
docs: Fixed typo in socket.getblocking() docs
4a9b7ad
- Change so that docs properly equate this with socket.gettimeout() != 0.
@joegeisbauer
docs: Added Misc/NEWS.d for updated documentation.
7ecd0cc
WIP: temp commit
@bedevere-botbedevere-bot mentioned this pull request May 27, 2023
Closed
@bedevere-botbedevere-bot added the docs Documentation in the Doc dir label May 27, 2023
@ghost

ghost commented May 27, 2023•
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@joegeisbauer-ce

joegeisbauer-ce commented May 27, 2023

Copy link
Copy Markdown
Author

This issue with the documentation goes back to v3.7.

@arhadthedevarhadthedev added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels May 27, 2023
@joegeisbauer-ce

joegeisbauer-ce commented Jun 3, 2023

Copy link
Copy Markdown
Author

Will this automatically get marked for review or do I need to do anything special here?

AlexWaygood
AlexWaygood approved these changes Jun 4, 2023
View reviewed changes

@AlexWaygoodAlexWaygood 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.

Thanks!

@AlexWaygoodAlexWaygood self-assigned this Jun 4, 2023
@AlexWaygoodAlexWaygood changed the title gh-104882: Updated socket documentation for relationship between socket.getblocking() and socket.gettimeout().gh-104882: Docs: fix description of relationship between socket.getblocking() and socket.gettimeout()Jun 4, 2023
@AlexWaygood
AlexWaygood merged commit 5a5ed7a into python:mainJun 4, 2023
@miss-islington

miss-islington commented Jun 4, 2023

Copy link
Copy Markdown
Contributor

Thanks @joegeisbauer for the PR, and @AlexWaygood 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 Jun 4, 2023
@joegeisbauer@miss-islington
pythongh-104882: Docs: fix description of relationship between `socke…
181e0ca
…t.getblocking()` and `socket.gettimeout()` (pythonGH-105026)
(cherry picked from commit 5a5ed7a)
Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
@bedevere-bot

bedevere-bot commented Jun 4, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-bot removed the needs backport to 3.12 only security fixes label Jun 4, 2023
@bedevere-bot

bedevere-bot commented Jun 4, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Jun 4, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 4, 2023
@joegeisbauer@miss-islington
pythongh-104882: Docs: fix description of relationship between `socke…
e885bad
…t.getblocking()` and `socket.gettimeout()` (pythonGH-105026)
(cherry picked from commit 5a5ed7a)
Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
AlexWaygood pushed a commit that referenced this pull request Jun 4, 2023
@miss-islington@joegeisbauer
[3.12]gh-104882: Docs: fix description of relationship between `sock…
9ce3312
…et.getblocking()` and `socket.gettimeout()` (GH-105026) (#105283)
gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026)
(cherry picked from commit 5a5ed7a)
Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
AlexWaygood pushed a commit that referenced this pull request Jun 4, 2023
@miss-islington@joegeisbauer
[3.11]gh-104882: Docs: fix description of relationship between `sock…
86eab08
…et.getblocking()` and `socket.gettimeout()` (GH-105026) (#105284)
gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026)
(cherry picked from commit 5a5ed7a)
Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
@AlexWaygood

AlexWaygood commented Jun 4, 2023

Copy link
Copy Markdown
Member

Thanks @joegeisbauer! I've merged the PR, and backported it to 3.12 and 3.11. Earlier versions of Python now only accept patches if they relate to security issues (which this isn't!), so it won't be backported to 3.10 or earlier.

I removed the NEWS entry before merging, as we don't usually include them for docs-only changes :-)

@joegeisbauer-ce
joegeisbauer-ce deleted the fix-issue-104882 branch June 4, 2023 17:02
@erlend-aaslanderlend-aasland mentioned this pull request Jun 6, 2023
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

@AlexWaygoodAlexWaygood

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@joegeisbauer-ce@miss-islington@bedevere-bot@AlexWaygood@arhadthedev@joegeisbauer