Skip to content

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

@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 <[email protected]>
Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
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 <[email protected]>
Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@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 <[email protected]>
Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
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 <[email protected]>
Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
…reserved`` (pythonGH-136794) (python#136827)

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

Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Matthieu Lienart <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
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