Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(3)

#18802: ipaddress documentation errors

Can't Edit
Can't Publish+Mail
Start Review
Created:
6 years, 6 months ago by jon
Modified:
3 years, 8 months ago
Reviewers:
ezio.melotti
CC:
Nick Coghlan, jongfoster, python_hda3.com, r.david.murray, docs_python.org, berkerpeksag, xiang.zhang, csabella, mariatta.wijaya+miss-islington_gmail.com
Visibility:
Public.

Patch Set 1 #

Total comments: 3

Patch Set 2 #

Unified diffs Side-by-side diffs Delta from patch set Stats Patch
Doc/library/ipaddress.rst View 1 10 chunks +72 lines, -23 lines 0 comments Download
Lib/test/test_ipaddress.py View 1 1 chunk +6 lines, -0 lines 0 comments Download

Messages

Total messages: 1
ezio.melotti
6 years, 6 months ago #1
http://bugs.python.org/review/18802/diff/9026/Doc/library/ipaddress.rst
File Doc/library/ipaddress.rst (right):

http://bugs.python.org/review/18802/diff/9026/Doc/library/ipaddress.rst#newco...
Doc/library/ipaddress.rst:760: address objects will always sort before the
interface objects.   Two interface
There's an extra space here.
Also a couple of lines in this chunk are too long.

http://bugs.python.org/review/18802/diff/9026/Doc/library/ipaddress.rst#newco...
Doc/library/ipaddress.rst:763: the comparison.  Note that you will get strange
results when comparing two
"getting strange results" doesn't sound appropriate for the doc.  You could say
that the result of comparing two interfaces is not defined in this case (is
there a reason why?).

http://bugs.python.org/review/18802/diff/9026/Doc/library/ipaddress.rst#newco...
Doc/library/ipaddress.rst:780: :class:`IPv4Address` don't follow the Liskov
Substitution Principle.  I.e. you
I'm not sure it's necessary to mention the LSP.  Also I'm not sure why you would
want to pass an interface where an address is expected, so maybe this whole
paragraph could be removed.
Sign in to reply to this message.

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+