Closes #17158: Add 'symbols' to help() welcome message; clarify 'modules spam'

messages.

diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 81fcfd9f0c434333f2ca6e0a81d6de69ff22c83a..5a5a4813a895c0402edfaec3f1014bde7d334cf8 100755 (executable)
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -1847,10 +1847,10 @@ Enter the name of any module, keyword, or topic to get help on writing
 Python programs and using Python modules.  To quit this help utility and
 return to the interpreter, just type "quit".
 
-To get a list of available modules, keywords, or topics, type "modules",
-"keywords", or "topics".  Each module also comes with a one-line summary
-of what it does; to list the modules whose summaries contain a given word
-such as "spam", type "modules spam".
+To get a list of available modules, keywords, symbols, or topics, type
+"modules", "keywords", "symbols", or "topics".  Each module also comes
+with a one-line summary of what it does; to list the modules whose name
+or summary contain a given string such as "spam", type "modules spam".
 ''' % tuple([sys.version[:3]]*2))
 
     def list(self, items, columns=4, width=80):
@@ -1955,9 +1955,10 @@ module "pydoc_data.topics" could not be found.
     def listmodules(self, key=''):
         if key:
             self.output.write('''
-Here is a list of matching modules.  Enter any module name to get more help.
+Here is a list of modules whose name or summary contains '{}'.
+If there are any, enter a module name to get more help.
 
-''')
+'''.format(key))
             apropos(key)
         else:
             self.output.write('''
@@ -1976,7 +1977,7 @@ Please wait a moment while I gather a list of all available modules...
             self.list(modules.keys())
             self.output.write('''
 Enter any module name to get more help.  Or, type "modules spam" to search
-for modules whose descriptions contain the word "spam".
+for modules whose name or summary contain the string "spam".
 ''')
 
 help = Helper()

diff --git a/Misc/NEWS b/Misc/NEWS
index 4871a4f349649dd5f62e969d0dad06921234ad1c..737f997780a2d197e0912936ad37770ec50fc96c 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -1122,6 +1122,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #17158: Add 'symbols' to help() welcome message; clarify
+  'modules spam' messages.
+
 - Issue #15847: Fix a regression in argparse, which did not accept tuples as
   argument lists anymore.