diff options
| author | Xiang Zhang <angwerzx@126.com> | 2018-03-08 04:24:36 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-08 04:24:36 (GMT) |
| commit | e405096ea91f516d411095b6fea4eec9668eac88 (patch) | |
| tree | 710f39a312231113301fe4dc002c9629fe538566 /Doc/library/ipaddress.rst | |
| parent | fc7df0e664198cb05cafd972f190a18ca422989c (diff) | |
| download | cpython-e405096ea91f516d411095b6fea4eec9668eac88.zip cpython-e405096ea91f516d411095b6fea4eec9668eac88.tar.gz cpython-e405096ea91f516d411095b6fea4eec9668eac88.tar.bz2 | |
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
Diffstat (limited to 'Doc/library/ipaddress.rst')
| -rw-r--r-- | Doc/library/ipaddress.rst | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst index 75c9107..76177a0 100644 --- a/Doc/library/ipaddress.rst +++ b/Doc/library/ipaddress.rst @@ -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 @@ -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 @@ -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 @@ -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 |