Mercurial > cpython-lru_cache-weakref
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 21466:3a93145b6a96 | 21467:4e35fa5d5708 |
|---|---|
| 390 keys during a dictionary lookup. Numeric values that compare equal | 390 keys during a dictionary lookup. Numeric values that compare equal |
| 391 have the same hash value (even if they are of different types, as is | 391 have the same hash value (even if they are of different types, as is |
| 392 the case for 1 and 1.0). | 392 the case for 1 and 1.0). |
| 393 \end{funcdesc} | 393 \end{funcdesc} |
| 394 | 394 |
| 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 | |
| 395 \begin{funcdesc}{hex}{x} | 405 \begin{funcdesc}{hex}{x} |
| 396 Convert an integer number (of any size) to a hexadecimal string. | 406 Convert an integer number (of any size) to a hexadecimal string. |
| 397 The result is a valid Python expression. Note: this always yields | 407 The result is a valid Python expression. Note: this always yields |
| 398 an unsigned literal. For example, on a 32-bit machine, | 408 an unsigned literal. For example, on a 32-bit machine, |
| 399 \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a | 409 \code{hex(-1)} yields \code{'0xffffffff'}. When evaluated on a |
