Skip to content

gh-136752: Clarify documentation for IPv{N}Address.is_reserved #136794

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.

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

Merged
merged 17 commits into from
Jul 19, 2025

Conversation

mlnrt
Copy link
Contributor

@mlnrt mlnrt commented Jul 19, 2025

This PR proposes a documentation improvement to clarify the conditions for the ipaddress is_reserved property to return True


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

@python-cla-bot
Copy link

python-cla-bot bot commented Jul 19, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@Dobatymo
Copy link
Contributor

Maybe you should specifially mention, that is_reserved does not correspond to the Reserved-by-Protocol column in the _iana-ipv4-special-registry source... only to the name.

@mlnrt
Copy link
Contributor Author

mlnrt commented Jul 19, 2025

Will do

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner changed the title gh-136752: clarify ipaddress documentation of the is_reserved property gh-136752: Clarify documentation for IPv{N}Address.is_reserved` Jul 19, 2025
@AA-Turner AA-Turner added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 19, 2025
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks!

A

@AA-Turner AA-Turner enabled auto-merge (squash) July 19, 2025 14:38
@AA-Turner AA-Turner changed the title gh-136752: Clarify documentation for IPv{N}Address.is_reserved` gh-136752: Clarify documentation for IPv{N}Address.is_reserved Jul 19, 2025
@AA-Turner AA-Turner disabled auto-merge July 19, 2025 14:40
@AA-Turner AA-Turner enabled auto-merge (squash) July 19, 2025 14:40
@AA-Turner AA-Turner merged commit 6293d8a into python:main Jul 19, 2025
30 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 19, 2025
@miss-islington-app
Copy link

Thanks @mlnrt for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 19, 2025
…d`` (pythonGH-136794)

(cherry picked from commit 6293d8a)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 19, 2025
…d`` (pythonGH-136794)

(cherry picked from commit 6293d8a)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 19, 2025

GH-136827 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 19, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 19, 2025

GH-136828 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 19, 2025
AA-Turner added a commit that referenced this pull request Jul 19, 2025
…ed`` (GH-136794) (#136827)

gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` (GH-136794)
(cherry picked from commit 6293d8a)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull request Jul 19, 2025
…ed`` (GH-136794) (#136828)

gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` (GH-136794)
(cherry picked from commit 6293d8a)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news sprint
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants