python / python/cpython

`help` function: misleading output in interactive mode, confusing output for `help(help)`

Open
#138,094 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs stdlib
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

When using the built-in help function in interactive mode, the current output when no topic is found is potentially misleading, in that the suggestions offered are not usable at the interactive help prompt, e.g.:

help> something
No Python documentation found for 'something'.
Use help() to get the interactive help utility.
Use help(str) for help on the str class.

Typing either of the suggested expressions at the help prompt will, of course, not work, because they're meant for use in Python code. And the suggestion about str seems to be irrelevant in interactive mode, where everything is a string anyway. I think it would be better not to offer these suggestions at all when running in interactive mode.

Additionally, running help(help) shows a large amount of irrelevant information related to the _Helper class from _sitebuiltins.py, with the usage instructions buried inside of it:

Output of help(help)
Help on _Helper in module _sitebuiltins object:

class _Helper(builtins.object)
 |  Define the builtin 'help'.
 |
 |  This is a wrapper around pydoc.help that provides a helpful message
 |  when 'help' is typed at the Python interactive prompt.
 |
 |  Calling help() at the Python prompt starts an interactive help session.
 |  Calling help(thing) prints help for the python object 'thing'.
 |
 |  Methods defined here:
 |
 |  __call__(self, *args, **kwds)
 |      Call self as a function.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

I think this could be improved by showing usage instructions when invoking help(help) from Python, but preserving the current behavior of repeating the intro text when looking up help via the interactive prompt.

I'll put in a PR shortly that attempts to improve both of these.

Linked PRs
  • gh-138095

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the _Helper implementation referenced in _sitebuiltins.py and trace how the interactive help prompt handles missing topics and help(help). Done means interactive mode no longer shows unusable suggestions, while help(help) presents usage instructions without the irrelevant class details.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.