Skip to content

Remove misleading parts of is_site_local() documentation #113152

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove misleading parts of is_site_local() documentation #113152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
812e582
Remove misleading parts of is_site_local() documentation
jstasiak Dec 15, 2023
b914510
Merge branch 'main' into remove-misleading-documentation
StanFromIreland Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions Doc/library/ipaddress.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,9 +363,7 @@ write code that handles both IP versions correctly. Address objects are
.. attribute:: is_site_local

``True`` if the address is reserved for site-local usage. Note that
the site-local address space has been deprecated by :RFC:`3879`. Use
:attr:`~IPv4Address.is_private` to test if this address is in the
space of unique local addresses as defined by :RFC:`4193`.
the site-local address space has been deprecated by :RFC:`3879`.

.. attribute:: ipv4_mapped

Expand Down
4 changes: 0 additions & 4 deletions Lib/ipaddress.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2075,8 +2075,6 @@ def is_site_local(self):
"""Test if the address is reserved for site-local.

Note that the site-local address space has been deprecated by RFC 3879.
Use is_private to test if this address is in the space of unique local
addresses as defined by RFC 4193.

Returns:
A boolean, True if the address is reserved per RFC 3513 2.5.6.
Expand Down Expand Up @@ -2355,8 +2353,6 @@ def is_site_local(self):
"""Test if the address is reserved for site-local.

Note that the site-local address space has been deprecated by RFC 3879.
Use is_private to test if this address is in the space of unique local
addresses as defined by RFC 4193.

Returns:
A boolean, True if the address is reserved per RFC 3513 2.5.6.
Expand Down
Loading