bpo-40635: Fix getfqdn() docstring and docs #27971
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akulakov
changed the title
Fidget-Spinner
added
needs backport to 3.9
needs backport to 3.10
Fidget-Spinner
approved these changes
Aug 26, 2021
Member
Fidget-Spinner
left a comment
Fidget-Spinner
left a comment
There was a problem hiding this comment.
Thanks Andrei, this LGTM. But let's hear from a socket/networking expert first (and whether they want a news item).
ambv
reviewed
Aug 26, 2021
Doc/library/socket.rst
Outdated
Comment on lines
810
to
812
| host, if available. The first name which includes a period is selected. If FQDN is not | ||
| available and *name* is empty or is ``'0.0.0.0'``, hostname from :func:`gethostname` is | ||
| returned. Otherwise, *name* is returned unchanged. |
Contributor
There was a problem hiding this comment.
Please don't exceed 79 characters per line.
Suggested change
| host, if available. The first name which includes a period is selected. If FQDN is not | |
| available and *name* is empty or is ``'0.0.0.0'``, hostname from :func:`gethostname` is | |
| returned. Otherwise, *name* is returned unchanged. | |
| host, if available. The first name which includes a period is selected. In | |
| case no fully qualified domain name is available and *name* was provided, | |
| it is returned unchanged. If *name* was empty or equal to ``'0.0.0.0'``, | |
| the hostname as returned by :func:`gethostname` is returned. |
Contributor
Author
There was a problem hiding this comment.
'as returned ... is returned' reads a bit awkward I think, is it okay if I use the same wording as in your suggestion for the docstring? ; which is:
[...] hostname from gethostname() is returned.
Contributor
There was a problem hiding this comment.
Sure, agreed. I just used what was originally in the doc but you're right that the docstring version is an improvement.
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Contributor
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 26, 2021
Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit fdcb675) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
|
GH-27977 is a backport of this pull request to the 3.10 branch. |
|
GH-27978 is a backport of this pull request to the 3.9 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 26, 2021
Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit fdcb675) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Contributor
Author
|
Thanks @ambv and @Fidget-Spinner for reviewing :) |
miss-islington
added a commit
that referenced
this pull request
Aug 26, 2021
miss-islington
added a commit
that referenced
this pull request
Aug 26, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue40635