Skip to content

GH-65056: Improve the IP address' is_global/is_private documentation - #113186

Merged
encukou merged 6 commits into
python:mainfrom
jstasiak:improve-ipaddress-docs
Mar 18, 2024
Merged

GH-65056: Improve the IP address' is_global/is_private documentation#113186
encukou merged 6 commits into
python:mainfrom
jstasiak:improve-ipaddress-docs

Conversation

@jstasiak

@jstasiak jstasiak commented Dec 15, 2023

Copy link
Copy Markdown
Contributor

It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed).

I opted to fully replace the docstrings with the content from the documentation to save myself some work.


📚 Documentation preview 📚: https://cpython-previews--113186.org.readthedocs.build/

…ation

It wasn't clear what the semantics of is_global/is_private are and, when
one gets to the bottom of it, it's not quite so simple (hence the
exceptions listed).

I opted to fully replace the docstrings with the content from the
documentation to save myself some work.
@jstasiak

ghost commented Dec 15, 2023

Copy link
Copy Markdown
Contributor Author

I think the news entry can be safely skipped here.

Note that the documentation is accurate assuming that #113179 gets merged and the 100.64.0.0/10 range handling is left unchanged.

I'll adapt the documentation as needed.

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

LGTM, but I'd prefer saying shared address space rather than (or in addition to) the numbers -- at least in the public docs.

Comment thread Doc/library/ipaddress.rst Outdated
Comment thread Doc/library/ipaddress.rst Outdated
Comment thread Doc/library/ipaddress.rst Outdated
Comment thread Lib/ipaddress.py Outdated
Comment thread Lib/ipaddress.py Outdated
Jakub Stasiak and others added 5 commits March 14, 2024 00:00
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@jstasiak

ghost commented Mar 13, 2024

Copy link
Copy Markdown
Contributor Author

That's more than fair, all suggestions applied.

@bedevere-app

ghost commented Apr 23, 2024

Copy link
Copy Markdown

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

@jstasiak

ghost commented May 30, 2024

Copy link
Copy Markdown
Contributor Author

For visibility: I created GH-119812 to handle the Shared Address Space (100.64.0.0/10) exception documented here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants