Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 732299f

Browse files
committed
Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
1 parent e088970 commit 732299f

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

Doc/lib/libfuncs.tex

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,16 @@ \section{Built-in Functions \label{built-in-funcs}}
392392
the case for 1 and 1.0).
393393
\end{funcdesc}
394394

395+
\begin{funcdesc}{help}{\optional{object}}
396+
Invoke the built-in help system. (This function is intended for
397+
interactive use.) If no argument is given, the interactive help
398+
system starts on the interpreter console. If the argument is a
399+
string, then the string is looked up as the name of a module,
400+
function, class, method, keyword, or documentation topic, and a
401+
help page is printed on the console. If the argument is any other
402+
kind of object, a help page on the object is generated.
403+
\end{funcdesc}
404+
395405
\begin{funcdesc}{hex}{x}
396406
Convert an integer number (of any size) to a hexadecimal string.
397407
The result is a valid Python expression. Note: this always yields

0 commit comments

Comments
 (0)