Skip to content
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

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

Merged
merged 3 commits into from
Jun 4, 2023
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a9b7ad
docs: Fixed typo in socket.getblocking() docs
joegeisbauer May 27, 2023
7ecd0cc
docs: Added Misc/NEWS.d for updated documentation.
joegeisbauer May 27, 2023
ea618b0
Delete unnecessary NEWS entry
AlexWaygood Jun 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1526,7 +1526,7 @@ to sockets.
Return ``True`` if socket is in blocking mode, ``False`` if in
non-blocking.

This is equivalent to checking ``socket.gettimeout() == 0``.
This is equivalent to checking ``socket.gettimeout() != 0``.

.. versionadded:: 3.7

Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2023-05-27-12-48-50.gh-issue-104882.dpAqXV.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix a typo in the documentation that describes the relationship between
``socket.getblocking`` and ``socket.gettimeout``, which should be
equivalence to ``socket.gettimeout() != 0.0.``