classification
Title: Minor difflib documentation bug
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: docs@python, lurchman, python-dev, terry.reedy
Priority: normal Keywords:

Created on 2015-10-30 16:21 by lurchman, last changed 2015-10-30 23:42 by terry.reedy. This issue is now closed.

Messages (2)
msg253743 - (view) Author: Andrew Scheller (lurchman) * Date: 2015-10-30 16:21
In the documentation for difflib.HtmlDiff.__init__ there's a couple of references to ``ndiff()``. I believe these should be modified to :func:`ndiff` (as used elsewhere in the difflib documentation) so that they get nicely hyperlinked in the HTML documentation.

See e.g. https://docs.python.org/2/library/difflib.html#difflib.HtmlDiff.__init__ and https://docs.python.org/3/library/difflib.html#difflib.HtmlDiff.__init__
where 'ndiff()' isn't hyperlinked, and https://docs.python.org/3/library/difflib.html#difflib.restore where 'ndiff()' *is* hyperlinked.
msg253770 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-10-30 23:42
New changeset 4ed175ee3cca by Terry Jan Reedy in branch '2.7':
Issue #25519: Mark difflib.ndiff as a functions where not already.
https://hg.python.org/cpython/rev/4ed175ee3cca

New changeset b7686cb0b698 by Terry Jan Reedy in branch '3.4':
Issue #25519: Mark difflib.ndiff as a functions where not already.
https://hg.python.org/cpython/rev/b7686cb0b698
History
Date User Action Args
2015-10-30 23:42:45terry.reedysetstatus: open -> closed
resolution: fixed
stage: resolved
2015-10-30 23:42:03python-devsetnosy: + python-dev
messages: + msg253770
2015-10-30 23:31:12terry.reedysetassignee: docs@python -> terry.reedy

nosy: + terry.reedy
versions: - Python 3.2, Python 3.3
2015-10-30 16:21:40lurchmancreate