summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGregory P. Smith <greg@mad-scientist.com>2009-05-04 19:34:45 (GMT)
committerGregory P. Smith <greg@mad-scientist.com>2009-05-04 19:34:45 (GMT)
commit95e3b9c8480067982ff93e641a6303a5bad88584 (patch)
treeccf0dd5ce7bb57a6ee2eb71b30a002968990351f /Doc
parent244651aa2f21db5006bbdc013d2586cbc10b313d (diff)
downloadcpython-95e3b9c8480067982ff93e641a6303a5bad88584.zip
cpython-95e3b9c8480067982ff93e641a6303a5bad88584.tar.gz
cpython-95e3b9c8480067982ff93e641a6303a5bad88584.tar.bz2
documentation clarification. mention bytes.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/ipaddr.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/ipaddr.rst b/Doc/library/ipaddr.rst
index 066b792..6f37b71 100644
--- a/Doc/library/ipaddr.rst
+++ b/Doc/library/ipaddr.rst
@@ -21,9 +21,10 @@ both IPv4 and IPv6.
Take an IP string or int and return an object of the correct type. Returns
an :class:`IPv4` or :class:`IPv6` object.
- The *ipaddr* parameter must be a string or integer representing the IP
- address. Either IPv4 or IPv6 addresses may be supplied. Integers less than
- 2**32 will be considered to be IPv4.
+ The *ipaddr* parameter must be a string, bytes or integer representing the
+ IP address in ascii, network byte order or as a number respectively. Either
+ IPv4 or IPv6 addresses may be supplied. Integers less than 2**32 will be
+ considered to be IPv4.
Raises :exc:`ValueError` if the *ipaddr* passed is not either an IPv4 or an
IPv6 address.