Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-112007: Re-organize help utility intro message (#112017) 

Most important: move how-to-quit sentence to the end and mention 'q'.
Re-group the other sentences and improve some wording.
---------
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This commit is contained in:
Terry Jan Reedy 2023-11-13 14:24:03 -05:00 committed by GitHub
parent d5491a6eff
commit b28bb130bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Lib/pydoc.py
View File

@ -2073,20 +2073,22 @@ has the same effect as typing a particular string at the help> prompt.
self.output.write('\n') self.output.write('\n')
def intro(self): def intro(self):
self.output.write(''' self.output.write('''\
Welcome to Python {0}'s help utility! Welcome to Python {0}'s help utility! If this is your first time using
Python, you should definitely check out the tutorial at
If this is your first time using Python, you should definitely check out https://docs.python.org/{0}/tutorial/.
the tutorial on the internet at https://docs.python.org/{0}/tutorial/.
Enter the name of any module, keyword, or topic to get help on writing 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 get a list of available
return to the interpreter, just type "quit". modules, keywords, symbols, or topics, enter "modules", "keywords",
"symbols", or "topics".
To get a list of available modules, keywords, symbols, or topics, type Each module also comes with a one-line summary of what it does; to list
"modules", "keywords", "symbols", or "topics". Each module also comes the modules whose name or summary contain a given string such as "spam",
with a one-line summary of what it does; to list the modules whose name enter "modules spam".
or summary contain a given string such as "spam", type "modules spam".
To quit this help utility and return to the interpreter,
enter "q" or "quit".
'''.format('%d.%d' % sys.version_info[:2])) '''.format('%d.%d' % sys.version_info[:2]))
def list(self, items, columns=4, width=80): def list(self, items, columns=4, width=80):