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

messages.
This commit is contained in:
Terry Jan Reedy 2013-02-11 02:23:13 -05:00
parent 4e08f786f0
commit 3420057adb
2 changed files with 11 additions and 7 deletions

View File

@ -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 Python programs and using Python modules. To quit this help utility and
return to the interpreter, just type "quit". return to the interpreter, just type "quit".
To get a list of available modules, keywords, or topics, type "modules", To get a list of available modules, keywords, symbols, or topics, type
"keywords", or "topics". Each module also comes with a one-line summary "modules", "keywords", "symbols", or "topics". Each module also comes
of what it does; to list the modules whose summaries contain a given word with a one-line summary of what it does; to list the modules whose name
such as "spam", type "modules spam". or summary contain a given string such as "spam", type "modules spam".
''' % tuple([sys.version[:3]]*2)) ''' % tuple([sys.version[:3]]*2))
def list(self, items, columns=4, width=80): def list(self, items, columns=4, width=80):
@ -1955,9 +1955,10 @@ module "pydoc_data.topics" could not be found.
def listmodules(self, key=''): def listmodules(self, key=''):
if key: if key:
self.output.write(''' 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) apropos(key)
else: else:
self.output.write(''' 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.list(modules.keys())
self.output.write(''' self.output.write('''
Enter any module name to get more help. Or, type "modules spam" to search 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() help = Helper()

View File

@ -1122,6 +1122,9 @@ Core and Builtins
Library 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 - Issue #15847: Fix a regression in argparse, which did not accept tuples as
argument lists anymore. argument lists anymore.