]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-940286: Fix pydoc to show cross refs correctly (GH-8390)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 23 Jul 2018 06:51:28 +0000 (23:51 -0700)
committerGitHub <noreply@github.com>
Mon, 23 Jul 2018 06:51:28 +0000 (23:51 -0700)
(cherry picked from commit d04f46c59f1d07d9bcc0ba910741296ac88d370d)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
Lib/pydoc.py
Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst [new file with mode: 0644]

index 8c707540030b297aa06ce32df3eb56b8d2e0bf9d..fffa2d50a29c2601a0f13d58f4781d9457c5c7d3 100644 (file)
@@ -1992,14 +1992,15 @@ module "pydoc_data.topics" could not be found.
         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).
diff --git a/Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst b/Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst
new file mode 100644 (file)
index 0000000..678ac7a
--- /dev/null
@@ -0,0 +1,2 @@
+pydoc's ``Helper.showtopic()`` method now prints the cross references of a
+topic correctly.