traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix some ipaddress documentation errors (GH-6021) 

* fix a typo: documention -> documentation
* fix the type of IPv?Network.hostmask
* add documentation about IPv?Network.netmask
* fix IPv6Network constructor doc that extended netmasks are not supported
(cherry picked from commit e405096ea9)

Co-authored-by: Xiang Zhang <angwerzx@126.com>
This commit is contained in:
Miss Islington (bot) 2018-03-07 20:41:27 -08:00 committed by GitHub
parent 7592c0a686
commit 15425cf245
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Doc/library/ipaddress.rst
View File

@ -234,7 +234,7 @@ write code that handles both IP versions correctly.
groups consisting entirely of zeroes included. 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: :class:`IPv4Address` class:
.. attribute:: packed .. attribute:: packed
@ -440,7 +440,11 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
.. attribute:: hostmask .. 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:: with_prefixlen
.. attribute:: compressed .. attribute:: compressed
@ -561,13 +565,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 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 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 is a single number, which represents a *prefix*. If no mask is provided,
representation of an IPv6 address. If it's the latter, the mask is it's considered to be ``/128``.
interpreted as a *net mask*. If no mask is provided, it's considered to
be ``/128``.
For example, the following *address* specifications are equivalent: Note that currently expanded netmasks are not supported. That means
``2001:db00::0/24`` and ``2001:db00::0/ffff:ff00::``. ``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 2. An integer that fits into 128 bits. This is equivalent to a
single-address network, with the network address being *address* and single-address network, with the network address being *address* and
@ -604,6 +607,7 @@ so to avoid duplication they are only documented for :class:`IPv4Network`.
.. attribute:: network_address .. attribute:: network_address
.. attribute:: broadcast_address .. attribute:: broadcast_address
.. attribute:: hostmask .. attribute:: hostmask
.. attribute:: netmask
.. attribute:: with_prefixlen .. attribute:: with_prefixlen
.. attribute:: compressed .. attribute:: compressed
.. attribute:: exploded .. attribute:: exploded