Commit graph

1666 commits

Author SHA1 Message Date
Guido van Rossum
7c0240f112 e.g. -> e.g., 1998-07-24 15:36:43 +00:00
Fred Drake
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
Guido van Rossum
b193c95165 Document Ellipsis (not much of a documentation snippet, but at least
it's mentioned.
1998-07-24 15:02:02 +00:00
Guido van Rossum
1eb200d360 Added 3 missing types: ComplexType, SliceType, EllipsisType. 1998-07-24 15:01:05 +00:00
Fred Drake
78a6ddbdd1 Move files around in a different way, so CVS picks up all the changes. ;-) 1998-07-24 14:27:22 +00:00
Fred Drake
3f8a59f146 Reflect file renamings for the Python Library Reference.
Fix style dependencies for HOWTO documents.
1998-07-24 13:58:27 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
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
Guido van Rossum
3a0ad6089b Changes copied from the FrameMaker version, and some new stuff
(complex numbers, power operator).
1998-07-23 21:57:42 +00:00
Fred Drake
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
Fred Drake
cf0fb8bfee Document the 'p' format character.
Clean up some of the markup.
1998-07-23 21:18:25 +00:00
Fred Drake
c457ca7ede Fix up Barry's markup, which didn't pass the latex test. ;-) 1998-07-23 20:31:53 +00:00
Barry Warsaw
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
Barry Warsaw
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
Fred Drake
27467e4b7e Logical markup. 1998-07-23 19:47:41 +00:00
Guido van Rossum
b18a93b4c8 Changes copied from the FrameMaker version (hardly anything original). 1998-07-23 19:36:00 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
465a42a58e Added targets dvi, pdf, and ps, to make all of the documents in those formats. 1998-07-23 18:10:51 +00:00
Fred Drake
b91e934cf1 Adjusted to use the new module synopsis support macros. 1998-07-23 17:59:49 +00:00
Fred Drake
fe7f3bc2aa Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
macros.
1998-07-23 17:55:31 +00:00
Guido van Rossum
dfb658c386 'name space' -> 'namespace' 1998-07-23 17:54:36 +00:00
Fred Drake
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
Fred Drake
2fcadb2ffb \py@ModSynopsisFilename: New macro; gives names of the .syn file. 1998-07-23 17:36:46 +00:00
Fred Drake
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
Fred Drake
c31cc38106 Ignore the new ".syn" files used to handle module synopses. 1998-07-23 17:33:10 +00:00
Guido van Rossum
83b2f8ad3d Lots of changes copied from the FrameMaker version. Also documented
some previously undocumented features.
1998-07-23 17:12:46 +00:00
Guido van Rossum
be260101cb # Oops, correct Latex errors. 1998-07-22 21:51:41 +00:00
Guido van Rossum
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
Guido van Rossum
897b9f0b0d Add new syntax for specifying filenames on break and clear commands. 1998-07-20 23:29:10 +00:00
Guido van Rossum
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
Fred Drake
a9f445cd8d Add libthreading.tex to LIBFILES. 1998-07-20 14:01:20 +00:00
Andrew M. Kuchling
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
Guido van Rossum
dfba2fbfd0 Eric Raymond documents two already-existing functions (bmp, png). 1998-07-17 19:01:29 +00:00
Fred Drake
f029548ac2 Added item about index item/subitem separation. 1998-07-08 21:42:41 +00:00
Fred Drake
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
Guido van Rossum
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
Guido van Rossum
7bda89f694 Rewritten a bit to address some criticism in the newsgroup. 1998-07-06 20:47:40 +00:00
Guido van Rossum
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
Fred Drake
1717ba498f Normalize markup. 1998-07-02 19:36:50 +00:00
Fred Drake
579d366458 Normalize the markup. 1998-07-02 19:35:12 +00:00
Fred Drake
3f6034dcce Added index entry. 1998-07-02 19:33:43 +00:00
Fred Drake
91e5211bbf Added \deprecated to exit_thread() function.
Reflects Guido's revision.
1998-07-02 19:33:12 +00:00
Fred Drake
8e54abe92e Fix the \kbd definition so it didn't leave the courier face on. 1998-07-01 14:49:25 +00:00
Fred Drake
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
Andrew M. Kuchling
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
Guido van Rossum
cf51dacfb8 Document __copy__() and __deepcopy__() methods. 1998-06-30 16:54:33 +00:00
Fred Drake
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
Guido van Rossum
8ec619f60e Note that readline returns '' on EOF, not "EOF" (whatever that may be). 1998-06-30 16:35:25 +00:00