Commit Graph

1698 Commits

Author SHA1 Message Date
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
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
Fred Drake 59160706b3 Somewhat updated, but not checked for everything (just the stuff I was using). 1998-06-19 21:18:28 +00:00
Guido van Rossum 7b7f6688d2 Added a stronger warning about changing the dictionary returned by
locals().
1998-06-18 16:45:34 +00:00
Guido van Rossum faac0136f4 # Untabified the example :-( 1998-06-17 22:38:09 +00:00
Guido van Rossum 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
Guido van Rossum 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
Guido van Rossum 872948350f Some extra notes, and describe a new class (AddressList), all by ESR. 1998-06-16 22:27:40 +00:00
Guido van Rossum 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
Guido van Rossum 0bd3795d6a Two small additions to make it identical to the obsolete Frame version. 1998-06-15 16:27:37 +00:00
Guido van Rossum dc1dab18a5 NewNew abstract, copied from the obsolete Frame version. 1998-06-15 16:27:09 +00:00
Guido van Rossum a3eebe60dc Add warning about use of lowercase/uppercase with maketrans(). 1998-06-11 16:03:30 +00:00
Guido van Rossum 444d0f87c9 Eric Raymond: added doc for isheader(); improved docs for constructor. 1998-06-11 13:50:02 +00:00
Guido van Rossum 1299100324 Document the changes I just checked in. 1998-06-10 21:34:27 +00:00
Guido van Rossum 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
Guido van Rossum 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
Guido van Rossum 5d23758be7 Added docs for strptime(). 1998-06-09 16:30:56 +00:00
Guido van Rossum 52481484e6 Clarify the type of the signal handler. 1998-06-09 15:42:25 +00:00
Guido van Rossum 13c8ef62e6 Say a bit more about .pyc and .pyo files. 1998-05-29 19:12:23 +00:00
Guido van Rossum a58e9edbef Document missing functions: xor, not, truth, countOf, indexOf, and
(new!) contains.
1998-05-22 18:48:37 +00:00
Fred Drake 6a50ba82ce Minor grammatical correction: "This module perform ..." --> "This module
performs ...".
1998-05-22 18:19:19 +00:00
Fred Drake 885215c3da Added support for AMK's {definitions} environment; thanks for the reminder! 1998-05-20 21:32:09 +00:00
Fred Drake 3bf7865a20 Added {definitions} environment, which has \term to define indivual terms.
Similar to {description}.
1998-05-20 17:42:17 +00:00
Fred Drake e194beb829 Don't use a separate node for footnotes; see if people scream. ;-) 1998-05-19 19:38:49 +00:00
Fred Drake e87ab1fbf2 Fix definition of release_version (global). 1998-05-19 19:37:55 +00:00
Fred Drake 7c68ab2f2b Added entry for mimetypes. 1998-05-19 19:13:01 +00:00
Fred Drake 806a1bf34f webcheck target in this Makefile wasn't used. 1998-05-19 18:04:44 +00:00
Fred Drake 79c0f0efc4 Fix the webcheck target so it checks the right files.... 1998-05-19 18:04:13 +00:00
Fred Drake edde150127 Add mimetypes documentation to library reference dependencies. 1998-05-19 15:04:21 +00:00
Fred Drake b818b46b38 Add section documenting mimetypes module. 1998-05-19 15:03:45 +00:00
Guido van Rossum c85be6a0ff Fix another oldie (item (b) only):
Date:    Fri, 20 Dec 1996 14:47:50 +0100
From:    Lele Gaifax <lele@nautilus.eclipse.it>
To:      Python List <python-list@cwi.nl>
Subject: Typos in ref manual

Hi all,
browsing the reference manual I noticed what seem two small errors:
  a) in the list of keywords (section 2.3.1) 'exec' is missing
  b) in the Operator Precedence table (5.12) the comparison operators
     include '=', but probably '==' was intended.
Hope this help,
lele.
1998-05-16 02:11:10 +00:00
Fred Drake e593b6213a Small change to the l2h target allowing the output dir, $(HTMLDIR), to be
a sibling of the html/ directory in the distribution.
1998-05-15 17:50:32 +00:00
Fred Drake a4565b0796 Update to use latex2html 98.1p5. 1998-05-15 17:14:17 +00:00
Fred Drake 8dbf46a79e Update to use latex2html 98.1p5.
Cleanup temporary files produced by latex2html in the output directory.
1998-05-15 17:13:08 +00:00
Fred Drake e0a0fcd552 Update note about latex2html version required. 1998-05-15 17:03:00 +00:00
Fred Drake cdbd391415 Add support for the Macintosh Library Modules document. 1998-05-15 17:02:10 +00:00
Fred Drake 5b73cdfe60 Revise comment about \let support a little to more accurately reflect the
support that's offered.
1998-05-15 16:59:38 +00:00
Fred Drake 13b1f43851 Ignore the mac/ directory.... 1998-05-15 16:56:44 +00:00
Fred Drake d637406df1 Update to use the output names used by latex2html for the Python Reference
Manual; the old FrameMaker names no longer apply.
1998-05-15 16:18:21 +00:00
Fred Drake 7a4ad0fc83 Extend handling for \let a bit, to also allow \let\something=<character>. We
still don't support things like \let^^M=\something, where ^^M could actually be
any active character.  Print a decent warning if we find one we can't handle.
1998-05-15 13:45:54 +00:00
Fred Drake 8d1b3384c3 Remove debugging echo. 1998-05-15 13:38:21 +00:00
Fred Drake e16f6798ae do_cmd_let(): Simple implementation to allow \let to be used to establish
synonyms for macros.  This supports:

	\let\newname = \oldname
	\let\newname\oldname

This is useful sometimes, and can at least avoid real errors at other times.
1998-05-15 04:28:37 +00:00
Fred Drake d07868ae52 Added support for \developer, \developers, \developersaddress. 1998-05-14 21:00:28 +00:00
Fred Drake 6df93ef9dd Added definitions for \developer, \developers, \developersaddress.
Ask Guido if you really want to know why.  ;-)
1998-05-14 20:56:31 +00:00
Fred Drake df825a10fc Fix the fix to allow the .tex document sources not live in ".". 1998-05-14 20:36:49 +00:00
Fred Drake 25d4e2873c Mostly spurious change to ensure that everyone's version of this picks up the
execute bit.... problem discovered by Guido.
1998-05-14 20:07:10 +00:00
Fred Drake f4fc476885 Don't run tools/toc2bkm.py unless we're building PDF.
Change the way TEXINPUTS gets defined to ensure that the directory containing
the main document file comes before any other dir, to allow documents to have
files that "override" like-named files elsewhere on the search path.  Guido
discovered we needed this.
1998-05-14 20:03:14 +00:00
Fred Drake 5c07d9b028 Updated markup style (got rid of \verb@...@, mostly). 1998-05-14 19:37:06 +00:00
Fred Drake 203b4f1a25 Add an index entry.
Bow to font lock.
1998-05-14 15:16:12 +00:00