Skip to content

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

Merged
AA-Turner merged 17 commits intopython:mainfrom
mlnrt:fix-doc-issue-136752
Jul 19, 2025
Merged

gh-136752: Clarify documentation for IPv{N}Address.is_reserved#136794
AA-Turner merged 17 commits intopython:mainfrom
mlnrt:fix-doc-issue-136752

Conversation

@mlnrt
Copy link
Copy Markdown
Contributor

@mlnrt mlnrt commented Jul 19, 2025 •
edited
Loading

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/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 19, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 19, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 19, 2025
Closed
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot bot commented Jul 19, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@Dobatymo
Copy link
Copy Markdown
Contributor

Dobatymo commented Jul 19, 2025

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
Copy Markdown
Contributor Author

mlnrt commented Jul 19, 2025

Will do

AA-Turner
AA-Turner reviewed Jul 19, 2025
View reviewed changes
@mlnrt @AA-Turner
Update Doc/library/ipaddress.rst
0c23c09 
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
AA-Turner
AA-Turner reviewed Jul 19, 2025
View reviewed changes
AA-Turner
AA-Turner approved these changes Jul 19, 2025
View reviewed changes
Copy link
Copy Markdown
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
Copy Markdown

miss-islington-app bot commented Jul 19, 2025

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
@mlnrt @AA-Turner @miss-islington
pythongh-136752: Clarify documentation for ``IPv{N}Address.is_reserve…
0a2fe58 
…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
@mlnrt @AA-Turner @miss-islington
pythongh-136752: Clarify documentation for ``IPv{N}Address.is_reserve…
fbdbfd0 
…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
Copy Markdown

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
Copy Markdown

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
@miss-islington @mlnrt @AA-Turner
[3.14] gh-136752: Clarify documentation for ``IPv{N}Address.is_reserv…
f8af7cb 
…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
@miss-islington @mlnrt @AA-Turner
[3.13] gh-136752: Clarify documentation for ``IPv{N}Address.is_reserv…
53aeb82 
…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>
@mlnrt mlnrt mentioned this pull request Jul 19, 2025
Open
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@mlnrt @AA-Turner @taegyunkim
pythongh-136752: Clarify documentation for ``IPv{N}Address.is_reserve…
2b37f9e 
…d`` (python#136794)

Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@mlnrt @AA-Turner @Agent-Hellboy
pythongh-136752: Clarify documentation for ``IPv{N}Address.is_reserve…
91905b3 
…d`` (python#136794)

Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington @mlnrt
@AA-Turner @kumaraditya303
[3.14] pythongh-136752: Clarify documentation for ``IPv{N}Address.is_…
ce51fc3 
…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 <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

Reviewers

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mlnrt @Dobatymo @AA-Turner