From: Fred Drake <fdrake@acm.org>
Date: Tue, 18 Dec 2001 16:31:08 +0000 (+0000)
Subject: Add documentation for the help() built-in; contributed by Ka-Ping Yee.
X-Git-Tag: v2.2.1c1~315
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=732299ff63d74318c1ee39ce50c9387b91439bda;p=thirdparty%2FPython%2Fcpython.git

Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
---

diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex
index 17c17226b043..c115a95d86ed 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