annotate Doc/ref/ref.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 8e5b537f87a1
children a5c8eca54aeb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 \documentclass{manual}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3 \title{Python Reference Manual}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
5 \input{boilerplate}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
7 \makeindex
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
8
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
9 \begin{document}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
10
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
11 \maketitle
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
12
8782
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8506
diff changeset
13 \ifhtml
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8506
diff changeset
14 \chapter*{Front Matter\label{front}}
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8506
diff changeset
15 \fi
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8506
diff changeset
16
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
17 \input{copyright}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
18
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
19 \begin{abstract}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
20
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
21 \noindent
8506
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
22 Python is an interpreted, object-oriented, high-level programming
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
23 language with dynamic semantics. Its high-level built in data
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
24 structures, combined with dynamic typing and dynamic binding, make it
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
25 very attractive for rapid application development, as well as for use
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
26 as a scripting or glue language to connect existing components
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
27 together. Python's simple, easy to learn syntax emphasizes
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
28 readability and therefore reduces the cost of program
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
29 maintenance. Python supports modules and packages, which encourages
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
30 program modularity and code reuse. The Python interpreter and the
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
31 extensive standard library are available in source or binary form
6bf5b87af02f NewNew abstract, copied from the obsolete Frame version.
Guido van Rossum <guido@python.org>
parents: 8263
diff changeset
32 without charge for all major platforms, and can be freely distributed.
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
33
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
34 This reference manual describes the syntax and ``core semantics'' of
11462
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
35 the language. It is terse, but attempts to be exact and complete.
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
36 The semantics of non-essential built-in object types and of the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
37 built-in functions and modules are described in the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
38 \citetitle[../lib/lib.html]{Python Library Reference}. For an
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
39 informal introduction to the language, see the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
40 \citetitle[../tut/tut.html]{Python Tutorial}. For C or
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
41 \Cpp{} programmers, two additional manuals exist:
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
42 \citetitle[../ext/ext.html]{Extending and Embedding the Python
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
43 Interpreter} describes the high-level picture of how to write a Python
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
44 extension module, and the \citetitle[../api/api.html]{Python/C API
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
45 Reference Manual} describes the interfaces available to
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 8782
diff changeset
46 C/\Cpp{} programmers in detail.
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
47
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
48 \end{abstract}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
49
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
50 \tableofcontents
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
51
8263
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
52 \input{ref1} % Introduction
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
53 \input{ref2} % Lexical analysis
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
54 \input{ref3} % Data model
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
55 \input{ref4} % Execution model
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
56 \input{ref5} % Expressions and conditions
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
57 \input{ref6} % Simple statements
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
58 \input{ref7} % Compound statements
b4d3d1a08e4d Markup consistency.
Fred Drake <fdrake@acm.org>
parents: 8231
diff changeset
59 \input{ref8} % Top-level components
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
60
17195
38ef46635949 Include the futures appendix.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
61 \appendix
38ef46635949 Include the futures appendix.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
62 \input{refa1} % Future statements and nested scopes
38ef46635949 Include the futures appendix.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
63
18191
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17195
diff changeset
64 \chapter{History and License}
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17195
diff changeset
65 \input{license}
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17195
diff changeset
66
8231
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
67 \input{ref.ind}
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
68
a103cf6d3845 The Python Reference Manual.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
69 \end{document}