Skip to content

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

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 3 commits into from
Jun 4, 2023
Merged

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

merged 3 commits into from
Jun 4, 2023

Conversation

@joegeisbauer
Copy link
Contributor

@joegeisbauer joegeisbauer commented May 27, 2023 •
edited by github-actions bot
Loading

@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-bot bedevere-bot mentioned this pull request May 27, 2023
Closed
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label May 27, 2023
@ghost
Copy link

ghost commented May 27, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@joegeisbauer
Copy link
Contributor Author

joegeisbauer commented May 27, 2023

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

@arhadthedev arhadthedev added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels May 27, 2023
@joegeisbauer
Copy link
Contributor Author

joegeisbauer commented Jun 3, 2023

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
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks!

@AlexWaygood AlexWaygood self-assigned this Jun 4, 2023
@AlexWaygood AlexWaygood 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:main Jun 4, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Jun 4, 2023

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

bedevere-bot commented Jun 4, 2023

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

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

bedevere-bot commented Jun 4, 2023

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

@bedevere-bot bedevere-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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
@AlexWaygood
Copy link
Member

AlexWaygood commented Jun 4, 2023

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 joegeisbauer deleted the fix-issue-104882 branch June 4, 2023 17:02
@erlend-aasland erlend-aasland mentioned this pull request Jun 6, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

@AlexWaygood AlexWaygood

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.

5 participants

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