diff options
author | Fred Drake <fdrake@acm.org> | 2001-12-18 16:31:08 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-12-18 16:31:08 (GMT) |
commit | 732299ff63d74318c1ee39ce50c9387b91439bda (patch) | |
tree | ec1a70ecaaafc386cbb35a6037374ea35559cad4 /Doc/lib | |
parent | e088970ce02e8d225bd28d4e2cf13b4b9b5e107d (diff) | |
download | cpython-732299ff63d74318c1ee39ce50c9387b91439bda.zip cpython-732299ff63d74318c1ee39ce50c9387b91439bda.tar.gz cpython-732299ff63d74318c1ee39ce50c9387b91439bda.tar.bz2 |
Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/libfuncs.tex | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex index 17c1722..c115a95 100644 --- a/Doc/lib/libfuncs.tex +++ b/Doc/lib/libfuncs.tex @@ -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 |