Skip to content

bpo-40635: Fix getfqdn() docstring and docs - #27971

Merged
ambv merged 7 commits into
python:mainfrom
akulakov:40635-Fix-socket-getfqdn-docs
Aug 26, 2021
Merged

bpo-40635: Fix getfqdn() docstring and docs#27971
ambv merged 7 commits into
python:mainfrom
akulakov:40635-Fix-socket-getfqdn-docs

Conversation

@akulakov

@akulakovakulakov commented Aug 26, 2021•
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

@akulakovakulakov changed the title Fix getfqdn() docstring and docsbpo-40635: Fix getfqdn() docstring and docsAug 26, 2021
Fidget-Spinner
Fidget-Spinner reviewed Aug 26, 2021
View reviewed changes
Comment threadDoc/library/socket.rst Outdated
Fidget-Spinner
Fidget-Spinner approved these changes Aug 26, 2021
View reviewed changes

@Fidget-SpinnerFidget-Spinner 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 Andrei, this LGTM. But let's hear from a socket/networking expert first (and whether they want a news item).

ambv
ambv reviewed Aug 26, 2021
View reviewed changes
Comment threadDoc/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.

@ambvambvAug 26, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@akulakovakulakovAug 26, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

'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.

@ambvambvAug 26, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, agreed. I just used what was originally in the doc but you're right that the docstring version is an improvement.

Comment threadLib/socket.py Outdated
akulakovand others added 3 commits August 26, 2021 12:32
@ambv
ambv merged commit fdcb675 into python:mainAug 26, 2021
@miss-islington

miss-islington commented Aug 26, 2021

Copy link
Copy Markdown
Contributor

Thanks @akulakov for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 26, 2021
@akulakov@miss-islington
bpo-40635: Fix getfqdn() docstring and docs (pythonGH-27971)
2116004
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fdcb675)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
@bedevere-bot

bedevere-bot commented Aug 26, 2021

Copy link
Copy Markdown

GH-27977 is a backport of this pull request to the 3.10 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.10 only security fixes label Aug 26, 2021
@bedevere-bot

bedevere-bot commented Aug 26, 2021

Copy link
Copy Markdown

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
@akulakov@miss-islington
bpo-40635: Fix getfqdn() docstring and docs (pythonGH-27971)
24728c3
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fdcb675)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
@akulakov
akulakov deleted the 40635-Fix-socket-getfqdn-docs branch August 26, 2021 18:42
@akulakov

akulakov commented Aug 26, 2021

Copy link
Copy Markdown
ContributorAuthor

Thanks @ambv and @Fidget-Spinner for reviewing :)

miss-islington added a commit that referenced this pull request Aug 26, 2021
@miss-islington@akulakov
bpo-40635: Fix getfqdn() docstring and docs (GH-27971)
719af92
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fdcb675)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
miss-islington added a commit that referenced this pull request Aug 26, 2021
@miss-islington@akulakov
bpo-40635: Fix getfqdn() docstring and docs (GH-27971)
f1e3fc4
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fdcb675)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
@slatenyslateny mentioned this pull request Jun 3, 2022
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ambvambvambv left review comments
@Fidget-SpinnerFidget-SpinnerFidget-Spinner approved these changes
@tirantiranAwaiting requested review from tiran

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@akulakov@miss-islington@bedevere-bot@ambv@Fidget-Spinner@the-knights-who-say-ni