Add documentation for the help() built-in; contributed by Ka-Ping Yee.

This is part of SF patch #494622.
This commit is contained in:
Fred Drake 2001-12-18 16:31:08 +00:00
parent e088970ce0
commit 732299ff63
1 changed files with 10 additions and 0 deletions

View File

@ -392,6 +392,16 @@ def my_import(name):
the case for 1 and 1.0).
\end{funcdesc}
\begin{funcdesc}{help}{\optional{object}}
Invoke the built-in help system. (This function is intended for
interactive use.) If no argument is given, the interactive help
system starts on the interpreter console. If the argument is a
string, then the string is looked up as the name of a module,
function, class, method, keyword, or documentation topic, and a
help page is printed on the console. If the argument is any other
kind of object, a help page on the object is generated.
\end{funcdesc}
\begin{funcdesc}{hex}{x}
Convert an integer number (of any size) to a hexadecimal string.
The result is a valid Python expression. Note: this always yields