Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-03-03 19:40:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

bpo-940286: Fix pydoc to show cross refs correctly (GH-8390)

Browse source 
(cherry picked from commit d04f46c59f)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-07-22 23:51:28 -07:00 • committed by GitHub
parent 0ff1746434
commit e9e6495eed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Lib/pydoc.py
View file

@ -1992,14 +1992,15 @@ def showtopic(self, topic, more_xrefs=''):
except KeyError:
self.output.write('no documentation found for %s\n' % repr(topic))
return
pager(doc.strip() + '\n')
doc = doc.strip() + '\n'
if more_xrefs:
xrefs = (xrefs or '') + ' ' + more_xrefs
if xrefs:
import textwrap
text = 'Related help topics: ' + ', '.join(xrefs.split()) + '\n'
wrapped_text = textwrap.wrap(text, 72)
self.output.write('\n%s\n' % ''.join(wrapped_text))
doc += '\n%s\n' % '\n'.join(wrapped_text)
pager(doc)
def _gettopic(self, topic, more_xrefs=''):
"""Return unbuffered tuple of (topic, xrefs).

2
Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst Normal file
View file

@ -0,0 +1,2 @@
pydoc's ``Helper.showtopic()`` method now prints the cross references of a
topic correctly.