Commit b2566cfb authored by Georg Brandl's avatar Georg Brandl

#9111: document that do_help() looks at docstrings.

parent 9c491c9b
...@@ -76,11 +76,13 @@ A :class:`Cmd` instance has the following methods: ...@@ -76,11 +76,13 @@ A :class:`Cmd` instance has the following methods:
are the beginning and ending indexes of the prefix text, which could be used to are the beginning and ending indexes of the prefix text, which could be used to
provide different completion depending upon which position the argument is in. provide different completion depending upon which position the argument is in.
All subclasses of :class:`Cmd` inherit a predefined :meth:`do_help`. This All subclasses of :class:`Cmd` inherit a predefined :meth:`do_help`. This
method, called with an argument ``'bar'``, invokes the corresponding method method, called with an argument ``'bar'``, invokes the corresponding method
:meth:`help_bar`. With no argument, :meth:`do_help` lists all available help :meth:`help_bar`, and if that is not present, prints the docstring of
topics (that is, all commands with corresponding :meth:`help_\*` methods), and :meth:`do_bar`, if available. With no argument, :meth:`do_help` lists all
also lists any undocumented commands. available help topics (that is, all commands with corresponding
:meth:`help_\*` methods or commands that have docstrings), and also lists any
undocumented commands.
.. method:: Cmd.onecmd(str) .. method:: Cmd.onecmd(str)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment