Commit graph

1745 commits

Author SHA1 Message Date
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
Guido van Rossum
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
Guido van Rossum
97ea116472 Documented the pop() method for lists.
# The brackets generated by \optional{} are real ugly.  Alas...
1998-06-30 15:56:23 +00:00
Guido van Rossum
9c59ce9b5a Documented os.linesep (line separator). 1998-06-30 15:54:27 +00:00
Guido van Rossum
cd90509d58 As suggested by pson@pson.pp.se, correct the docs for head(), body(),
article().
1998-06-30 14:53:41 +00:00
Andrew M. Kuchling
52a79e8e1c Changed URL to crypto page. 1998-06-30 13:42:05 +00:00
Guido van Rossum
6c373f758f Document new default arg to groups() and new functions/methods
groupdict() and findall().
1998-06-29 22:48:01 +00:00
Guido van Rossum
002f7aae08 Note that no .pyc/.pyo files are created for script files. 1998-06-28 19:16:38 +00:00
Guido van Rossum
f9cfb173cd Now cmd is documented too. 1998-06-28 18:01:59 +00:00
Guido van Rossum
a40d643cdc Documented smtplib, multifile 1998-06-28 17:58:06 +00:00
Guido van Rossum
8ddbe9119f Documented cmd, smtplib, multifile 1998-06-28 17:57:27 +00:00
Guido van Rossum
f78a52c1ae Added cmd, smtplib, multifile 1998-06-28 17:57:05 +00:00
Guido van Rossum
8668e8e49c Contributions by Eric Raymond: documentation for modules
cmd, multifile and smtplib.
1998-06-28 17:55:53 +00:00
Guido van Rossum
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Andrew M. Kuchling
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
Guido van Rossum
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
Guido van Rossum
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
Fred Drake
1b0ff2c32f eval() example: Removed final interpreter prompt; other examples don't have
the empty prompt.
1998-06-19 21:19:50 +00:00