7313b03469
My first Perl object. ;-)
...
SynopsisTable objects are used to store the table of module synopses for
a single chapter it the manual.
1998-07-24 20:34:59 +00:00
246837d0f5
Fix markup of an \indexiii --> only two parameters were given.
1998-07-24 20:28:22 +00:00
d540509682
Changes copied from the FrameMaker version. Hardly anything (but then
...
this is the shortest chapter.)
Hurray, I'm done with this!
1998-07-24 18:56:17 +00:00
5399d68c4b
Changes copied from the FrameMaker version. Not too much.
1998-07-24 18:51:11 +00:00
56c2013d15
Changes copied from the FrameMaker version. Also documented some
...
previously undocumented features.
Packages and the import mechanism in general are still left
undocumented.
1998-07-24 18:25:38 +00:00
34116ba933
Remove all-<format> targets in favor of just <format>.
...
Fix some comments.
For lib.pdf, run tools/toc2bkm.py to get "bookmarks" in acroread.
1998-07-24 15:42:12 +00:00
7c0240f112
e.g. -> e.g.,
1998-07-24 15:36:43 +00:00
c2aa9fbad9
Remove use of the avant package; Helvetica isn't as pretty, but works for
...
acroread. The problem this solves is likely dependent on font availability,
so keeping things simple is a good solution.
1998-07-24 15:19:38 +00:00
b193c95165
Document Ellipsis (not much of a documentation snippet, but at least
...
it's mentioned.
1998-07-24 15:02:02 +00:00
1eb200d360
Added 3 missing types: ComplexType, SliceType, EllipsisType.
1998-07-24 15:01:05 +00:00
78a6ddbdd1
Move files around in a different way, so CVS picks up all the changes. ;-)
1998-07-24 14:27:22 +00:00
3f8a59f146
Reflect file renamings for the Python Library Reference.
...
Fix style dependencies for HOWTO documents.
1998-07-24 13:58:27 +00:00
64e3b43583
Move files around to get the names to match the module names except for
...
case. Two modules (SocketServer, BaseHTTPServer) still don't match; those
names are just too long!
1998-07-24 13:56:11 +00:00
889f53d4e0
Reduce the number of levels in the Table of Contents by one, mostly for the
...
Python Library Reference. The other manuals do not suffer.
This does not affect HOWTO documents.
1998-07-24 13:54:29 +00:00
13529c41e4
Remove item about one section === one module; done.
...
Add item about howto docs that use \localmoduletable problem for howto
documents.
1998-07-24 13:02:17 +00:00
3a0ad6089b
Changes copied from the FrameMaker version, and some new stuff
...
(complex numbers, power operator).
1998-07-23 21:57:42 +00:00
5420f3321d
\textunderscore: Re-define with a width that's more appropriate for the
...
courier font used in Python code. This still isn't *good*, but
makes the width about right in most cases. (Exception: it's now
a little wide in \var words.)
1998-07-23 21:41:02 +00:00
cf0fb8bfee
Document the 'p' format character.
...
Clean up some of the markup.
1998-07-23 21:18:25 +00:00
c457ca7ede
Fix up Barry's markup, which didn't pass the latex test. ;-)
1998-07-23 20:31:53 +00:00
da00c878bd
Added descriptions of EnvironmentError and OSError; updated IOError to
...
reflect its new place in the exception hierarchy; fixed typos, etc.
1998-07-23 19:57:35 +00:00
eef2cd14c9
Updated the description of os.error to reflect the fact that it is now
...
equivalent to exceptions.OSError.
1998-07-23 19:50:09 +00:00
27467e4b7e
Logical markup.
1998-07-23 19:47:41 +00:00
b18a93b4c8
Changes copied from the FrameMaker version (hardly anything original).
1998-07-23 19:36:00 +00:00
3bd9ab0ef3
Use the new module synopsis syntax, even though we don't need a synopsis table
...
for this chapter. This protects against backend changes for \declaremodule.
1998-07-23 19:33:08 +00:00
8cab549c0a
use_latex(): Hack to pass .syn files though uniq, so that the last module
...
in a HOWTO document isn't listed in the synopsis table twice. This
will do until the real bug is found (low priority!).
1998-07-23 19:13:52 +00:00
465a42a58e
Added targets dvi, pdf, and ps, to make all of the documents in those formats.
1998-07-23 18:10:51 +00:00
b91e934cf1
Adjusted to use the new module synopsis support macros.
1998-07-23 17:59:49 +00:00
fe7f3bc2aa
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
...
macros.
1998-07-23 17:55:31 +00:00
dfb658c386
'name space' -> 'namespace'
1998-07-23 17:54:36 +00:00
a488f30627
Lots of new stuff for "module synopsis support." Public interface consists
...
of three macros, one which replaces some of the current conventions used in
the module sections:
\declaremodule: Requires two parameters: module type (standard, builtin,
extension), and the module name. An optional parameter should be
given as the basis for the module's "key" used for linking to or
referencing the section. The "key" should only be given if the
module's name contains underscores, and should be the name with the
underscore's stripped. This should be the first thing after the
\section used to introduce the module.
\modulesynopsis: Requires a single parameter: a short, one-liner
description of the module that can be used as part of the chapter
introduction. This should probably be placed just after the
\declaremodule, but may be placed anywhere in the same section.
\localmoduletable: No parameters. If a .syn file exists for the current
chapter (or for the entire document in howto docs), a synopsistable
is created with the contents loaded from the .syn file.
Some re-organization due to module synopsis support.
Some \def's changed to \newcommand's.
1998-07-23 17:50:45 +00:00
2fcadb2ffb
\py@ModSynopsisFilename: New macro; gives names of the .syn file.
1998-07-23 17:36:46 +00:00
1cc6d53f65
\py@ModSynopsisFilename: New macro; gives names of the "current" .syn file.
...
\chapter: Extended, ensures that a pending module synopsis is written out
and then closes the .syn file for the preceeding chapter.
1998-07-23 17:36:14 +00:00
c31cc38106
Ignore the new ".syn" files used to handle module synopses.
1998-07-23 17:33:10 +00:00
83b2f8ad3d
Lots of changes copied from the FrameMaker version. Also documented
...
some previously undocumented features.
1998-07-23 17:12:46 +00:00
be260101cb
# Oops, correct Latex errors.
1998-07-22 21:51:41 +00:00
0af2f63056
Document how to make a POST request with urlopen().
...
Change the argument name for quote() and quote_plus() to safe (which
matches the implementation).
Add doc for the *new* function urlencode().
1998-07-22 21:34:21 +00:00
897b9f0b0d
Add new syntax for specifying filenames on break and clear commands.
1998-07-20 23:29:10 +00:00
d623d20e7d
Complete the addition of libthreading.tex. (Isn't it annoying that
...
you need to edit four files in order to add one section to the manual?)
1998-07-20 17:34:50 +00:00
a9f445cd8d
Add libthreading.tex to LIBFILES.
1998-07-20 14:01:20 +00:00
16440e63be
Added libthreading.tex ; this is mostly the contents of threading_api.py,
...
with LaTeX markup added, and some small rewrites to improve the prose.
1998-07-20 13:46:10 +00:00
dfba2fbfd0
Eric Raymond documents two already-existing functions (bmp, png).
1998-07-17 19:01:29 +00:00
f029548ac2
Added item about index item/subitem separation.
1998-07-08 21:42:41 +00:00
5da5a68325
Fix suggested by Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it> to keep the
...
large letter at the top of each index section with at least the first entry
for that letter.
1998-07-08 21:37:25 +00:00
a4289a79f8
In the example iterating over sys.argv and opening each argument,
...
change it to iterate over sys.argv[1:]. Suggestion by Gerry Wiener.
1998-07-07 20:18:06 +00:00
7bda89f694
Rewritten a bit to address some criticism in the newsgroup.
1998-07-06 20:47:40 +00:00
5f574aace9
Added back the description of the exec statement. It appears that I
...
accidentally cut it out when removing the access statement! Added a
paragraph on __builtins__ and other possible manipulations of the key
space of the dictionaries. Added some index entries.
1998-07-06 13:18:39 +00:00
1717ba498f
Normalize markup.
1998-07-02 19:36:50 +00:00
579d366458
Normalize the markup.
1998-07-02 19:35:12 +00:00
3f6034dcce
Added index entry.
1998-07-02 19:33:43 +00:00
91e5211bbf
Added \deprecated to exit_thread() function.
...
Reflects Guido's revision.
1998-07-02 19:33:12 +00:00
8e54abe92e
Fix the \kbd definition so it didn't leave the courier face on.
1998-07-01 14:49:25 +00:00
3240dd2bc2
Mark the actual SMTP commands (HELO, etc.) the same way FTP & NNTP commands
...
are in the appropriate sections.
Some minor nits.
1998-07-01 14:10:52 +00:00
108943c216
Added a section to the chapter on modules, describing the package system.
...
The text is almost completely from GvR's essay on packages; some
introductory paragraphs have been removed, and everything after the
'Details' section in the HTML has been dropped (seems too technical). A
paragraph has been added after the sample package layout stating that there
must be a file called__init__.py in a directory to make it a package.
1998-07-01 13:58:55 +00:00
cf51dacfb8
Document __copy__() and __deepcopy__() methods.
1998-06-30 16:54:33 +00:00
5b68362a3a
Use the real name of the module: "smtplib", not "smtp".
...
Use logical (& consistent) markup.
Added a see-also section at the end.
1998-06-30 16:53:52 +00:00
8ec619f60e
Note that readline returns '' on EOF, not "EOF" (whatever that may be).
1998-06-30 16:35:25 +00:00
472b9a3f06
Clearly I was to quick with the previous commit...
...
Need to add \optional{} to sort argument too.
Made x a \var in descr of pop.
Fixed note for pop() and mentioned that it is experimental.
Also added pop to index.
1998-06-30 16:02:35 +00:00
97ea116472
Documented the pop() method for lists.
...
# The brackets generated by \optional{} are real ugly. Alas...
1998-06-30 15:56:23 +00:00
9c59ce9b5a
Documented os.linesep (line separator).
1998-06-30 15:54:27 +00:00
cd90509d58
As suggested by pson@pson.pp.se, correct the docs for head(), body(),
...
article().
1998-06-30 14:53:41 +00:00
52a79e8e1c
Changed URL to crypto page.
1998-06-30 13:42:05 +00:00
6c373f758f
Document new default arg to groups() and new functions/methods
...
groupdict() and findall().
1998-06-29 22:48:01 +00:00
002f7aae08
Note that no .pyc/.pyo files are created for script files.
1998-06-28 19:16:38 +00:00
f9cfb173cd
Now cmd is documented too.
1998-06-28 18:01:59 +00:00
a40d643cdc
Documented smtplib, multifile
1998-06-28 17:58:06 +00:00
8ddbe9119f
Documented cmd, smtplib, multifile
1998-06-28 17:57:27 +00:00
f78a52c1ae
Added cmd, smtplib, multifile
1998-06-28 17:57:05 +00:00
8668e8e49c
Contributions by Eric Raymond: documentation for modules
...
cmd, multifile and smtplib.
1998-06-28 17:55:53 +00:00
73d8bff44d
Document optional kwargs argument to start_new_thread(). Also
...
document new LockType and reverse the preference for exit()
vs. exit_thread() -- exit() is now preferred and exit_thread() is
obsolete.
1998-06-27 18:25:44 +00:00
e5836d9811
Mark the 'whence' parameter of the file object's seek() method as optional;
...
it's already decribed that way in the description.
1998-06-25 16:26:56 +00:00
2d4a54da32
Removed loading of shared font stuff from howto.cls and manual.cls, moving it
...
to pypaper.sty.
Added the use of the "avant" package to use AvantGarde for the sans-serif
font instead of the helvetica font loaded by the "times" package.
1998-06-22 17:50:34 +00:00
44c413b05e
Make the large letter at the top of each section use the sans-serif font,
...
like any other header.
1998-06-22 17:27:48 +00:00
8e7c82648f
Added texinputs/pypaper.sty to the list of manual style files, so that the
...
.dvi files are properly dependent on it.
1998-06-22 17:14:47 +00:00
65b7863efc
Fix unclear wording pointed out by Tim Peters, about the interaction between
...
^ and the pos argument to re.match().
Also, fixed a typo in libregex.tex.
1998-06-22 15:02:42 +00:00
a8a1b9bc65
There's no point in mentioning F6 as an alternate EOF on DOS -- it
...
doesn't work on modern Windows systems, and Control-Z works
everywhere.
1998-06-22 14:28:39 +00:00
a7874d1505
Revert the change of revision 1.30. While it's in general a laudable
...
goal to use isinstance(x, y) instead of comparing type(x) to y, it
doesn't make sense to change this in the example code for the type()
builtin...
1998-06-22 14:07:36 +00:00
1b0ff2c32f
eval() example: Removed final interpreter prompt; other examples don't have
...
the empty prompt.
1998-06-19 21:19:50 +00:00
59160706b3
Somewhat updated, but not checked for everything (just the stuff I was using).
1998-06-19 21:18:28 +00:00
7b7f6688d2
Added a stronger warning about changing the dictionary returned by
...
locals().
1998-06-18 16:45:34 +00:00
faac0136f4
# Untabified the example :-(
1998-06-17 22:38:09 +00:00
bca1207ac8
Documented that by default the output goes to stderr, and that a file
...
keyword argument can be used to direct it somewhere else. Also
documented all the other functions in this module, and even added a
little example.
# Haven't tested the latex for correctness -- all latex installations
# appear broken.
1998-06-17 22:37:26 +00:00
777dcc6b21
Change the description of input() -- it is exactly equivalent to
...
eval(raw_input(s)). The statement about breaking a long expression
over multiple lines is no longer true.
1998-06-17 15:16:40 +00:00
872948350f
Some extra notes, and describe a new class (AddressList), all by ESR.
1998-06-16 22:27:40 +00:00
60f2f0cf8e
Lots of changes to get this in sync with the Frame version.
...
Added raw strings, imaginary literals, assert and exec (!) keywords, a
table about Resererved classes of identifiers, and more.
1998-06-15 18:00:50 +00:00
0bd3795d6a
Two small additions to make it identical to the obsolete Frame version.
1998-06-15 16:27:37 +00:00
dc1dab18a5
NewNew abstract, copied from the obsolete Frame version.
1998-06-15 16:27:09 +00:00
a3eebe60dc
Add warning about use of lowercase/uppercase with maketrans().
1998-06-11 16:03:30 +00:00
444d0f87c9
Eric Raymond: added doc for isheader(); improved docs for constructor.
1998-06-11 13:50:02 +00:00
1299100324
Document the changes I just checked in.
1998-06-10 21:34:27 +00:00
3e5fe422cc
Document several variables that were previously undocumented,
...
including the new __stdin__, __stdout__ and __stderr__.
Also moved setttrace around to its proper place in the alphabet.
1998-06-10 17:57:44 +00:00
929bd0e02e
Added notes about epochs, the year 2038, and a small Y2K disclaimer
...
(all with index entries!). Also update the list of functions that
take or yield a time represented as a 9-tuple.
1998-06-09 21:25:41 +00:00
5d23758be7
Added docs for strptime().
1998-06-09 16:30:56 +00:00
52481484e6
Clarify the type of the signal handler.
1998-06-09 15:42:25 +00:00
13c8ef62e6
Say a bit more about .pyc and .pyo files.
1998-05-29 19:12:23 +00:00
a58e9edbef
Document missing functions: xor, not, truth, countOf, indexOf, and
...
(new!) contains.
1998-05-22 18:48:37 +00:00
6a50ba82ce
Minor grammatical correction: "This module perform ..." --> "This module
...
performs ...".
1998-05-22 18:19:19 +00:00
885215c3da
Added support for AMK's {definitions} environment; thanks for the reminder!
1998-05-20 21:32:09 +00:00
3bf7865a20
Added {definitions} environment, which has \term to define indivual terms.
...
Similar to {description}.
1998-05-20 17:42:17 +00:00
e194beb829
Don't use a separate node for footnotes; see if people scream. ;-)
1998-05-19 19:38:49 +00:00
e87ab1fbf2
Fix definition of release_version (global).
1998-05-19 19:37:55 +00:00
Fred Drake
Guido van Rossum
Barry Warsaw
Andrew M. Kuchling