From e9e6495eedd7fb588964ffa50e8bf2c5ce9c6051 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Sun, 22 Jul 2018 23:51:28 -0700 Subject: [PATCH] bpo-940286: Fix pydoc to show cross refs correctly (GH-8390) (cherry picked from commit d04f46c59f1d07d9bcc0ba910741296ac88d370d) Co-authored-by: Berker Peksag --- Lib/pydoc.py | 5 +++-- .../next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst diff --git a/Lib/pydoc.py b/Lib/pydoc.py index 8c70754003..fffa2d50a2 100644 --- a/Lib/pydoc.py +++ b/Lib/pydoc.py @@ -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 index 0000000000..678ac7a122 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-07-22-07-59-32.bpo-940286.NZTzyc.rst @@ -0,0 +1,2 @@ +pydoc's ``Helper.showtopic()`` method now prints the cross references of a +topic correctly. -- 2.50.1