Mercurial > cpython-lru_cache-weakref
diff Doc/lib/libfuncs.tex @ 21467:4e35fa5d5708 legacy-trunk
Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Tue, 18 Dec 2001 16:31:08 +0000 |
| parents | 33d59e18b68d |
| children | 8a791330fc20 |
line wrap: on
line diff
--- a/Doc/lib/libfuncs.tex Tue Dec 18 15:51:55 2001 +0000 +++ b/Doc/lib/libfuncs.tex Tue Dec 18 16:31:08 2001 +0000 @@ -392,6 +392,16 @@ 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
