Skip to content

Fix some ipaddress documentation errors #6021

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

Merged
zhangyangyu merged 2 commits into from
Mar 8, 2018
Merged

Fix some ipaddress documentation errors #6021

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f36e86
Fix some ipaddress documentation errors
zhangyangyu Mar 8, 2018
3e16f3e
remove trailing spaces
zhangyangyu Mar 8, 2018
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
20 changes: 12 additions & 8 deletions Doc/library/ipaddress.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ write code that handles both IP versions correctly.
groups consisting entirely of zeroes included.


For the following attributes, see the corresponding documention of the
For the following attributes, see the corresponding documentation of the
:class:`IPv4Address` class:

.. attribute:: packed
Expand Down Expand Up @@ -442,7 +442,11 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.

.. attribute:: hostmask

The host mask, as a string.
The host mask, as an :class:`IPv4Address` object.

.. attribute:: netmask

The net mask, as an :class:`IPv4Address` object.

.. attribute:: with_prefixlen
.. attribute:: compressed
Expand Down Expand Up @@ -588,13 +592,12 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.

1. A string consisting of an IP address and an optional mask, separated by
a slash (``/``). The IP address is the network address, and the mask
can be either a single number, which means it's a *prefix*, or a string
representation of an IPv6 address. If it's the latter, the mask is
interpreted as a *net mask*. If no mask is provided, it's considered to
be ``/128``.
is a single number, which represents a *prefix*. If no mask is provided,
it's considered to be ``/128``.

For example, the following *address* specifications are equivalent:
``2001:db00::0/24`` and ``2001:db00::0/ffff:ff00::``.
Note that currently expanded netmasks are not supported. That means
``2001:db00::0/24`` is a valid argument while ``2001:db00::0/ffff:ff00::``
not.

2. An integer that fits into 128 bits. This is equivalent to a
single-address network, with the network address being *address* and
Expand Down Expand Up @@ -631,6 +634,7 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
.. attribute:: network_address
.. attribute:: broadcast_address
.. attribute:: hostmask
.. attribute:: netmask
.. attribute:: with_prefixlen
.. attribute:: compressed
.. attribute:: exploded
Expand Down