Commit Graph

978 Commits

Author SHA1 Message Date
Fred Drake 14f8521952 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 13:52:04 +00:00
Fred Drake 7372e5793d Make the word "Module" in the section header start with an upper-case "M".
Minor grammatical nit.
1997-12-17 13:51:08 +00:00
Fred Drake 045c7fc9b9 Make the word "Module" in the section header start with an upper-case "M".
Remove the leading comment declaring this to be a template for module
documentation.
1997-12-17 13:47:39 +00:00
Fred Drake 6f070108df Make the word "Module" in the section header start with an upper-case "M"
for both modules documented here.
1997-12-17 13:45:50 +00:00
Fred Drake dccd9dbf52 Make the word "Module" in the section header start with an upper-case "M"
for both built-in and standard modules.  They were different.
1997-12-17 13:44:37 +00:00
Fred Drake 819b789f36 gen_index_id(): New function. Construct an index key such that the sort
is stable and the form is only defined in one place, since we do
	some fancy footwork with the keys to separate the defining instance
	of a module reference from other references in the HTML index.

make_index_entry():  Override the standard definition to use get_index_id().

make_str_index_entry():  Moved to myformat.perl; only needed there.

index_key_eq():  Override the standard definition.  Add key transforms to
	remove extra junk from the end of the keys; it was only there to
	maintain ordering.

clean_key():  Remove key transform no longer needed at this stage, because
	keeping it makes the sort unstable.

add_idx():  Add key transforms to undo the mess we do to separate a module's
	defining and reference entries.  Don't make the text bold.
1997-12-17 03:08:27 +00:00
Fred Drake 84818d7aad make_mod_index_entry(): New function. Create the index entry for a module.
my_module_index_helper():  Do the actual work for \*modindex{}, including
	both the defining and reference forms.

make_str_index_entry():  Moved from .latex2html-init; it's really specific
	to the presentation.
1997-12-17 02:59:39 +00:00
Guido van Rossum e4eb2231fd AMK's latest 1997-12-17 00:23:39 +00:00
Fred Drake 72df9bcba2 do_cmd_refbimodindex(), do_cmd_refstmodindex(): New functions, handle the
reference form of \bimodindex{} and \stmodindex{}.

my_parword_index_helper():  Fixed to include proper anchor in result text.
1997-12-16 21:13:20 +00:00
Fred Drake 5ca9033062 Index the RFC822 reference (some other RFC references were alreaddy indexed).
Add index reference to mailbox module; also remove comment that it's
undocumented (it has been).
1997-12-16 15:19:47 +00:00
Fred Drake 8e0799817e The \indexsubitem definition for the actual exceptions did not actually
change the \indexsubitem value; fixed.
1997-12-16 14:54:32 +00:00
Fred Drake 9d2f7d414d Oops, ".pythonrc.py" should *always* be marked with \file{}; one occurrance
escaped with \var{}.
1997-12-16 14:43:37 +00:00
Fred Drake 5493205ba4 Module names should be in \code{}.
Added index reference to site module.
1997-12-16 14:41:36 +00:00
Fred Drake 0514ce126a Descriptions for delitem(), __delitem__(): These delete a value, not set it.
Lots of little nits:  parameter names in text should be \var{}, etc.
1997-12-16 14:29:48 +00:00
Fred Drake 4f496cc5b1 Fixed index module reference. 1997-12-16 04:08:24 +00:00
Fred Drake 90f2e5e202 Added a named target for referencing. 1997-12-16 04:06:33 +00:00
Fred Drake bfc28bcfdf Used a named target to form the reference to the Built-in Functions section. 1997-12-16 04:06:06 +00:00
Fred Drake 6d2bdb682d Fixed index module reference.
Changed references to regex/regsub modules to point to re.
1997-12-16 04:04:25 +00:00
Fred Drake 3aa289537c Fixed index references to modules. (This is *not* the spam module!) 1997-12-16 00:02:01 +00:00
Fred Drake e14388c4b8 Fixed index references to modules. 1997-12-15 22:28:38 +00:00
Fred Drake 19d58273c5 Fixed index references to modules.
Made references to files use \file{} instead of \code{}.
1997-12-15 22:23:52 +00:00
Fred Drake 356818eccb Fixed index references to modules. 1997-12-15 22:20:33 +00:00
Fred Drake 8274f32a6d Fixed index references to modules.
Changed regex reference to re.
1997-12-15 22:19:46 +00:00
Fred Drake f5eaa2efb8 Fixed index references to modules.
Added new index entry for mimetools module.
1997-12-15 22:13:50 +00:00
Fred Drake a51f5a48e5 Fixed index references to modules. 1997-12-15 22:09:42 +00:00
Fred Drake 4af1814858 \refmodindex{}: New macro, used to make an index reference to a module which
is neither standard nor built-in.  (Used for sitecustomize entry.)
1997-12-15 22:08:14 +00:00
Fred Drake 9ab2b2ec5b Fixed index references to modules.
Placed references closer to usage.
1997-12-15 21:59:33 +00:00
Fred Drake 54820dc8e4 Fixed index references to modules. 1997-12-15 21:56:05 +00:00
Fred Drake 6206394a4b Changed illegal \stmodindex{} to \refstmodindex{}, added index reference
to the stat module.
1997-12-15 21:42:51 +00:00
Fred Drake 8a528bd10d Added some module references to the index. 1997-12-15 21:40:15 +00:00
Fred Drake 207e57b617 Added definitions of \refbimodindex{} and \refstmodindex{}, which should be
used to add index references for built-in and standard modules, respectively.

Modified \bimodindex{} and \stmodindex{} to make the page number bold, to
allow the defining instance of a module to stand out in the index.

Check-ins which fix improper use of \bimodindex{} and \stmodindex{} will be
made as fixes are applied.  Misc. indexing updates will occur as a side
effect in some cases.
1997-12-15 21:37:45 +00:00
Fred Drake d9dbfbd33c At the top, made it clear that the \bimodindex{} and \stmodindex{} are only
used for the defining entry for the module, not every index reference.
1997-12-15 21:20:03 +00:00
Guido van Rossum c0cc6351e5 regex -> re 1997-12-15 17:53:31 +00:00
Fred Drake 095f35ad60 Changed \indexsubitem from ({\tt HTMLParser} method) to just
(HTMLParser method).

This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:34:35 +00:00
Fred Drake 1247ceab94 Changed \indexsubitem from ({\tt SGMLParser} method) to just
(SGMLParser method).

This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:33:34 +00:00
Fred Drake 0add4c120d Changed \indexsubitem from ({\tt XMLParser} method) to just (XMLParser method).
This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:32:31 +00:00
Fred Drake d56924258a add_idx(): Don't add unnecessary markup around the little markers stuck in the
index to cross-references; an image doesn't benefit by being bold!
1997-12-11 21:46:07 +00:00
Guido van Rossum 48d0437d1d AMK's latest version. 1997-12-11 20:19:08 +00:00
Guido van Rossum bd49ac4492 The 'l' flag (locale specific matching) has been renamed to 'L'. 1997-12-10 23:05:53 +00:00
Guido van Rossum d58daff686 Planned release date for 1.5b2. 1997-12-10 18:56:48 +00:00
Guido van Rossum 736fe5e918 Document binary format and __init__-free unpickling. Added a pointer
to cPickle.
1997-12-09 20:45:08 +00:00
Guido van Rossum a42c17851c Turn the table for flags into a nested itemized environment. 1997-12-09 20:41:47 +00:00
Guido van Rossum eefcba61f4 Fix a little mess (Likecode{...} -> Like \code{...}) in recently added text. 1997-12-09 19:47:24 +00:00
Guido van Rossum 8291bb3693 Reference to PYTHONPATH should be PYTHONSTARTUP. 1997-12-09 19:46:45 +00:00
Guido van Rossum 28f9a68deb Added note about the module's obsolescence. 1997-12-09 19:45:47 +00:00
Guido van Rossum 138dac5a1b Added more warnings about ni's demise. 1997-12-09 15:03:41 +00:00
Fred Drake a2e268aa40 Mark file names with \file{} instead of \code{}. 1997-12-09 03:28:42 +00:00
Fred Drake c5aec05967 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
descriptions really make things look a bit better, and should improve the
ability to re-purpose the content.
1997-12-08 21:25:41 +00:00
Fred Drake 8ca70069a6 Added Emacs turd so this file has the correct mode in Emacs / X/Emacs, even
if you don't have .perl in your mode table.
1997-12-08 20:59:54 +00:00
Fred Drake a5a3cdcf4d Added Emacs turd so this file has the correct mode in Emacs / X/Emacs.
clean_key():  Override the standard LaTeX2HTML clean_key() to remove a
	leading HTML tag, if present.  This broke the indexes for the library
	reference (at least) since many of the strings began with <code> or
	something similar.
1997-12-08 20:58:13 +00:00
Guido van Rossum a417b66204 Updated the README to the current status. Added a note about the
"times" option.
1997-12-08 20:51:26 +00:00
Guido van Rossum 0b334104ac New version from AMK -- with minor corrections to make it legal latex. 1997-12-08 17:33:40 +00:00
Fred Drake f3d729c8f9 Fixed SFT #23842: leave in non-standard style options when checking in an
update.  ;-(
1997-12-08 15:48:35 +00:00
Fred Drake e907208b30 Some reorganization (all limit operations & constants together, and all usage
functions and constants together).

Make explicit datadesc sections for each of the constants which might appear,
and have a description of each.  (Descriptions are based on the Linux
documentation and sources and the Solaris man pages.)

Hopefully Jeremy won't mind, because I didn't ask.  ;-)
1997-12-06 07:25:41 +00:00
Guido van Rossum a0eaa2200c Some manipulations with tags to get the TOC and Index to look better 1997-12-06 00:39:45 +00:00
Guido van Rossum 3e396cf9ff New WML file, this time with working Title and Author tags, and
mapping chapter and section headings to more appropriate nodes so that
the TOC actually works.  Now generates one HTML page per chapter.
1997-12-06 00:38:30 +00:00
Fred Drake eee08cdd54 Make examples consistently use 4-space indentation.
Use \file{} for file names.

Prefer \code{blat} and \emph{blat} to {\tt blat} and {\em blat}; this matches
current style in the Library Reference a bit better.

Made the example startup banner current.  The version number should be
bumped before the next release.
1997-12-04 15:43:15 +00:00
Fred Drake 0d3b4f8beb Fixed unresolved reference problem; this module wasn't \label{}ed.
Remove spurious underscore following book title.  Added specific reference to
a Win32 networking book.

Changed \indexsubitem from (in module SocketServer) to (SocketServer protocol),
since it's talking about a protocol supported by a collection of classes.
1997-12-04 14:36:52 +00:00
Fred Drake 98b032a7c0 Removed unnecessary escaping. 1997-12-04 14:20:59 +00:00
Fred Drake 1cf87496a6 Arg; more nits, but I may as well finish the job.
Removed the large comment remaining from the template documentation
section; the template tells us to remove these once they're not needed.

Remove some trailing whitespace from VM instruction pseudo-code.
1997-12-04 04:57:56 +00:00
Fred Drake 7381e28399 Fixed BINARY_RSHIFT documentation to indicate a right shift instead of a left
shift.

Adjust whitespace around "=" in VM machine descriptions to be consistent
throughout the document.
1997-12-04 04:51:12 +00:00
Fred Drake c2297c1ce9 Changed {\sc gdbm} to \code{gdbm} everywhere.
Fixed \indexsubitem to gdbm instead of dbm.

Changed dbm to \code{dbm} everywhere.
1997-12-04 04:45:28 +00:00
Fred Drake 7c4cba8325 Added handler for opcodedesc environment.
Fixed weird index behavior.
1997-12-03 19:45:08 +00:00
Fred Drake f2d7e5528d make_str_index_entry(): New function. Similar to make_index_entry(), but
includes the string in the returned value instead of the dummy
	filler character.

add_idx():  Override the latex2html function of the same name; this gets
	the anchor properly embedded in the <dt> element, so the index
	works in Grail too.
1997-12-03 19:44:27 +00:00
Guido van Rossum ab76af3d65 Provide default for blocksize on retrbinary (Skip Montanaro). 1997-12-03 19:34:14 +00:00
Fred Drake 456035f4b1 The biggie: changed the funcdesc environments used for opcode descriptions
to use the opcodedesc environment.

Changed a \code{} to a \file{} near the start where a file is referenced.

Fixed a typo:  "on" --> "one" in ROT_THREE description.

Wherever opcodes were referenced by name, use \code{OPCODE_NAME}; usage was
inconsistent.  Ideally, another macro would be defined since these don't
represent code a programmer would type, but that's minor even for me.  It'll
probably get converted automatically in the SGML conversion project.  Whether
that matters or not isn't relevant at this point.
1997-12-03 04:06:57 +00:00
Fred Drake a610f9f8c1 Added environment for defining PyVM instructions. This is only used in
the libdis.tex file I'm about to check in.

I'm not sure this is really an optimal solution yet, but it may be the best
alternative.  It avoids describing the instructions as either data items or
functions.

This change was discussed with Guido.  (Guido:  Take a look at the LaTeX
output for this; if this is reasonable I'll go ahead and update the perl
code in myformat.perl to match.)
1997-12-03 03:42:39 +00:00
Guido van Rossum 240ddc8a68 Typo in example (missing '=') discovered by Sandy Langbart. 1997-12-02 20:08:06 +00:00
Guido van Rossum 3593e5c4c3 Document new behavior of isinstance() when using a type object. 1997-12-02 19:15:01 +00:00
Guido van Rossum 0f280b6099 Use $LOGNAME instead of $USER to get the current user -- it seems to
be the state of the art.
1997-12-01 18:50:09 +00:00
Barry Warsaw 433c8ca328 Removed Queue.py. It's documented now. 1997-12-01 16:35:54 +00:00
Fred Drake 798654fc68 Added \indexsubitem definition; functions were previously indexed for the
wrong module.
1997-11-30 05:53:22 +00:00
Fred Drake 2478f9d5a2 Added \indexsubitem definition. Non-optimal, but two modules are sharing
the documentation here.
1997-11-30 05:38:44 +00:00
Fred Drake 92796d1f01 Added \indexsubitem definition; functions were previously indexed for the
wrong module.
1997-11-30 05:27:26 +00:00
Fred Drake 7730cc067f Updated \indexsubitem; functions had been indexed for the wrong module. 1997-11-30 05:23:47 +00:00
Guido van Rossum 73ec2c0081 Slip of the keyboard (f__ should be __). Dunno why I had a totally
messed up (but not checked in) version in my work files and didn't
notice before releasing 1.5 -- at least the distributed latex file
doesn't have the bogus warning about changed __init__ semantics.
1997-11-27 01:39:15 +00:00
Guido van Rossum 330c660f66 The dependency of tarhtml on l2h was a bad idea. 1997-11-26 15:31:32 +00:00
Guido van Rossum ee9f820cf1 Documented brand new behavior of sys.ps1 and sys.ps2 (str() is applied
to get the actual prompt).
1997-11-25 21:12:27 +00:00
Guido van Rossum 84cca446f2 Added utility target tarhtml to tar and gzip the HTML files plus their
support (GIFS, icons, style sheets).
1997-11-25 20:49:09 +00:00
Guido van Rossum 28fbe4dcd2 Adding the icons used by latex2html output to the CVS tree. 1997-11-25 20:14:07 +00:00
Guido van Rossum 628b4085b5 Ignore html files generated by webmaker. 1997-11-25 20:10:40 +00:00
Guido van Rossum 000eb0a138 Augmented the script so that (at CNRI anyway) it also invokes webmaker
to create the HTML.
1997-11-25 20:10:19 +00:00
Guido van Rossum 4323f7c7fd Simple index for the reference manuals (mostly for use on the Windows
platform).
1997-11-25 18:27:23 +00:00
Guido van Rossum 71ace95e12 Updated to the most pressing 1.5 issues. 1997-11-25 18:20:52 +00:00
Guido van Rossum 580aa8dbc3 Several changes, e.g. restructuring of the intro to be closer to what
it ought to be.  Maybe the last checkin before 1.5b1 is released.
1997-11-25 15:34:51 +00:00
Fred Drake cb91e7bbd3 Added the "italic correction" command ("\/") to the list of ignored commands.
There is at least one of there in the library reference, and this reduces
the warning count.  We *do* know what to do with it!
1997-11-25 04:06:21 +00:00
Fred Drake e624e0f99e Removed leading comment about this being "introductory" documentation;
compared to most, I'd say this section is fairly thorough.

Fixed \indexsubitem definitions for symbol and token module sub-documents.
Perhaps these should be moved to their own files, but they're awefully
small.
1997-11-25 04:04:00 +00:00
Guido van Rossum f259efe3d9 Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
Guido van Rossum 3e1e274d0b Don't use $math$ mode to typeset a simple '>' sign. Use \code, not \samp. 1997-11-25 00:43:34 +00:00
Guido van Rossum 9d62e80e46 Remove strange use of $math$ mode to produce a backslash. 1997-11-25 00:35:44 +00:00
Guido van Rossum 5b7220f7ee Oops, did the previous delete the wrong way. 1997-11-25 00:05:12 +00:00
Guido van Rossum d5da7a63c1 Get rid of last traces of module 'audio' 1997-11-24 23:59:31 +00:00
Guido van Rossum 00f1569983 Add fileinput. 1997-11-24 17:50:09 +00:00
Guido van Rossum bc12f78bb3 Adding Martin von Loewis' documentation for his locale module. 1997-11-20 21:04:27 +00:00
Guido van Rossum e084f0beea Add description for some modules that have been added since this intro
section was last revised...
1997-11-20 21:03:33 +00:00
Guido van Rossum 3472026347 Add description for Queue; fix typo (whichdbm should be whichdb). 1997-11-20 21:00:03 +00:00
Barry Warsaw 17c8e781c0 libqueue.tex: Documentation for the Queue.py module.
Makefile: Add dependency on libqueue.tex

lib.tex: Place the libqueue.tex documentation just after libthread.tex
since Queue depends on thread support in Python.
1997-11-20 19:54:16 +00:00
Barry Warsaw 4552f3d6de In the description of sub(), give a better explanation of the
interface when repl is a function.  Also give a simple example of
using a function repl.
1997-11-20 00:15:13 +00:00
Guido van Rossum e4a93bc4b3 Fix the release date for 1.5b1 to be Nov. 26 1997-11-18 15:32:15 +00:00
Guido van Rossum d9a26ff9ca Add support for NULL macro (like UNIX, ABC etc.). 1997-11-18 15:31:16 +00:00
Guido van Rossum 2974f0fe9a Add xmllib; remove (slow) from description of htmllib. 1997-11-18 15:30:40 +00:00
Guido van Rossum 7336935e4c dis is now documented; bisect is deemed useful. 1997-11-18 15:30:13 +00:00
Guido van Rossum f7790c608d Document s.connect_ex(), which does not raise an exception on error. 1997-11-18 15:29:20 +00:00
Guido van Rossum 364e643fdd Clarified reference to old profiler.
Mention conversion to Perl-style regular expressions.
1997-11-18 15:28:46 +00:00
Guido van Rossum 5de64883d8 Added doc for errorcode dictionary. 1997-11-18 15:27:51 +00:00
Guido van Rossum eae121e436 Adding dis and xmllib docs 1997-11-18 15:11:47 +00:00
Guido van Rossum a10768ae44 Docu for xmllib.py, by Sjoerd Mullender. 1997-11-18 15:11:22 +00:00
Guido van Rossum b62b6d145e Docu for dis.py, written by Martin von Loewis. 1997-11-18 15:10:53 +00:00
Guido van Rossum 9d37a4d332 Small wording change about global and local trace functions. 1997-10-27 19:57:20 +00:00
Fred Drake 040e565261 Ooops, found too more references to old conditions on floating point values. 1997-10-24 21:15:55 +00:00
Fred Drake ae18e9fc1c Removed obsolete discussion on _xdr helper module. 1997-10-24 21:14:36 +00:00
Guido van Rossum d7dc2eb708 Put {} around \^ in sets to force latex2html to do the right thing... 1997-10-22 03:03:44 +00:00
Guido van Rossum 828a0bdb1d count() now has a 4th parameter too. Also rephrased the docs for find
to use the same, better words to explain start/end.
1997-10-20 22:40:26 +00:00
Guido van Rossum 871cf161f1 Documented exc_info(); also updated exc_type and last_type docs. 1997-10-20 22:38:43 +00:00
Fred Drake 9e63faaa66 Change Python-as-executable-script example to use "#! /usr/bin/env python"
since that's now the recommended way to do it.

In pickling discussion, change "code{pickle}" (not missing leading "\") to
"This" since the immediately preceeding sentence ended with the same text
(with the proper "\").  Fixes a formatting bug and an odd glitch in the
writing.
1997-10-15 14:37:24 +00:00
Fred Drake 2950b2d881 Restore the \seealso formatting that got lost when I updated the math
module documentation.
1997-10-13 22:06:17 +00:00
Fred Drake 9dcc5a94c5 Add support for ctypedesc, cvardesc, seealso, seemodule, seetext.
This seems to take care of everything but tables and equations.
1997-10-13 22:04:17 +00:00
Fred Drake 7cd60442b4 Remove macpath entry -- it is already documented. 1997-10-13 22:02:09 +00:00
Fred Drake 5451d67dd9 socket_type ==> SocketType 1997-10-13 21:31:02 +00:00
Fred Drake 120ac20c40 Remove superfluous comman from between "not" and "in" when describing the
"not in" operator.
1997-10-13 20:48:17 +00:00
Fred Drake 36fbe76a45 struct _frozen:
Use spaces instead of tabs to indent structure definition; tabs don't
	work in tex/latex.

PyImport_FrozenModules:
	struct _freeze ==> struct _frozen
1997-10-13 18:18:33 +00:00
Guido van Rossum 6cd7ecb10b The sequence behavior is now on the Exception root class rather than
on the StandardError class.
1997-10-07 14:41:04 +00:00
Guido van Rossum fdacc58bfe Added pointer to api.tex and note about the out-of-date-ness of this
document.
1997-10-07 14:40:16 +00:00
Guido van Rossum 18b0db3b53 Set Oct 10 as the release date. 1997-10-07 14:39:43 +00:00
Guido van Rossum 9faf4c57b0 Change title to {Python/C API Reference Manual}; remove \bcode \ecode
which appears to be out of fashion in this file.
1997-10-07 14:38:54 +00:00
Fred Drake 6f2a26d42b And "ni" has been documented... 1997-10-06 21:53:50 +00:00
Fred Drake 2df75832b3 Oops; don't know if this was my typo or not: There was a "p" on a line that
should have been blank.
1997-10-06 21:52:31 +00:00
Fred Drake c211254334 Updated the section "Parsing Python". 1997-10-06 21:41:30 +00:00
Fred Drake 14bf341f16 Added keyword module entry. 1997-10-06 21:40:48 +00:00
Fred Drake e061a51de1 Minor nits (Lib/token.py is a file, token is a module...).
Added docs for symbol and token modules at the end.
1997-10-06 21:40:20 +00:00
Fred Drake db12f343bc Documentation for the keyword module. 1997-10-06 21:39:16 +00:00
Fred Drake 00eb96a126 Move the pprint docs after the code docs, so that all parser/codegen type
things come together.
1997-10-06 21:26:03 +00:00
Barry Warsaw dc0f00ad03 Document the mapping object's new get() method. 1997-10-06 17:50:48 +00:00
Fred Drake 04ac894189 Add the four latex2html output directories: api, ext, lib, tut. 1997-10-06 13:20:17 +00:00
Guido van Rossum c44d3d6664 Done with tread state descriptions. Sigh! 1997-10-06 05:10:47 +00:00
Guido van Rossum 0bfd146594 Added strerror() 1997-10-05 18:54:52 +00:00
Guido van Rossum bc3b13643d Removed emacs.py 1997-10-05 18:54:36 +00:00
Guido van Rossum eb53ae4928 Fixed some stuff that was incorrectly copied from regex. 1997-10-05 18:54:07 +00:00
Guido van Rossum 7974b0f2d8 Documented __import__, callable, isinstance, issubclass,
and slice.
1997-10-05 18:53:00 +00:00
Guido van Rossum df3dba049d Documented new exceptions and exception classes. 1997-10-05 18:51:26 +00:00
Guido van Rossum 5344d4fd2e Add -N0 to dvips flags to generate page structure comments. 1997-10-05 18:51:02 +00:00
Guido van Rossum 42cefd03cf Checkpoint. Added docs for the new exception handling APIs and for
the interfaces defined in import.h.
1997-10-05 15:27:29 +00:00
Fred Drake b55e07f4eb Fixed up formatting. 1997-09-30 21:59:27 +00:00
Fred Drake 1b914b3397 Fixed up formatting, added descriptions for previously undocumented functions. 1997-09-30 20:14:50 +00:00
Guido van Rossum 3cdb8f3286 Update the description and the example to the new functionality, which
is mostly concentrated in a generalized find_module() and the new
load_module().  Added the new module type constants.  Declare that
SEARCH_ERROR and a whole bunch of module-type-specific functions are
obsolete.
1997-09-09 20:53:37 +00:00
Guido van Rossum 9cf4e2bde7 Change packages to site-packages (so it's clearly not a package itself). 1997-09-08 02:02:37 +00:00
Guido van Rossum 16221126d6 Added warning about ni's obsolescence. Retracted semantic changes
(i.e. when using ni, the old __init__.py semantics prevail!)
1997-09-07 03:02:39 +00:00
Guido van Rossum 593801142e Initial revision 1997-09-07 02:56:35 +00:00
Guido van Rossum f01dff7e93 Give in to Mike Meyer -- add *both* lib/python1.5/packages and
lib/site-python to the path (if they exist).  This is a reasonable
compromise.
1997-09-03 22:05:54 +00:00
Guido van Rossum 28cad964ec Document newly revamped site configuration mechanism.
Damn the criticism in c.l.p!
1997-08-30 20:03:28 +00:00
Guido van Rossum 36764b8b0e Added docs for 'user' customization module. Renamed libuser.tex
(which had UserDict/UserList) to libuserdict.tex.
1997-08-30 20:02:25 +00:00
Guido van Rossum b2afc811c2 Added os.altsep; this is '/' on DOS/Windows, and None on systems with
a sane filename syntax.
1997-08-29 22:37:44 +00:00
Guido van Rossum 282290f821 Referred to POSIX docs as well as to Unix docs. 1997-08-27 14:54:25 +00:00
Guido van Rossum e20aef574a Ignore whitespace between formats (not internal to a count+format). 1997-08-26 20:39:54 +00:00
Guido van Rossum 81e479a11f Removed some colons that shouldn't be there (probably leftovers from
docstring conversion).
1997-08-25 18:28:03 +00:00
Fred Drake 5de31fc094 Oops, don't suppress echo of the rm command in l2hclean! 1997-08-22 18:20:33 +00:00
Fred Drake 03ff6f7474 Simplify LaTeX2HTML targets && support re-use of output directories (which
saves re-generation of images).

Add l2hclean target.
1997-08-22 18:18:54 +00:00
Fred Drake 289f97d0ea Changed description of SchedParams() in the following way:
\bar{Besocial} --> \var{besocial}
	     ^--- note case ----^

The fixed version matches the signature.  Changed "\bar{Besocial} gives ..."
to "The \var{besocial} flag gives ..." to keep from starting the sentence
with a lowercase token.

(The \bar{} --> \var{} change was required to keep LaTeX happy.)
1997-08-22 13:51:31 +00:00
Fred Drake 2999607e59 Added missing "\end{funcdesc}" after FindFolder documentation. 1997-08-22 13:45:13 +00:00
Guido van Rossum 08157f8db6 mention cPickle and cStringIO 1997-08-21 02:29:19 +00:00
Guido van Rossum b904629f75 Fix some badly botched prototypes for PyRun* c.s. 1997-08-21 02:28:57 +00:00
Guido van Rossum e229d8636d Misc Mac mods by Jack. Added libmacic.tex, and these patches:
libmacfs.tex	Document NewAliasMinimalFromFullPath
libmacos.tex	Document SetEventHandler and SchedParams
libmacui.tex	Document asynchronous event handling
libmailbox.tex	Removed mime-turds that somehow got in here
1997-08-18 15:14:26 +00:00
Guido van Rossum 5060b3be9b Consistently change Python-C API to Python/C API; added lots of new
introductory text for reference counts and error handling, with good
examples.
1997-08-17 18:02:23 +00:00
Guido van Rossum b235d9e673 Tweaked all l2h targets to remove the target directory before renaming
the intermediate target directory.
1997-08-15 19:12:08 +00:00
Guido van Rossum 09270b51e4 Fixes to make it pass latex without complaints. 1997-08-15 18:57:32 +00:00
Guido van Rossum 9085822f28 the usual 1997-08-15 02:52:46 +00:00
Guido van Rossum 1574d78550 Date 1997-08-15 02:52:35 +00:00
Guido van Rossum 1acceb0650 Added AMK's first cut at docs for re.py 1997-08-14 23:12:18 +00:00
Guido van Rossum 4a944d7a47 Added more stuff on initialization (still rudimentary) 1997-08-14 20:35:38 +00:00
Guido van Rossum 59a61352ad Added new intro sections (incomplete); fixed various typos 1997-08-14 20:34:33 +00:00
Guido van Rossum 3572d3718b Updated platform specific notes (it is now more common to have this)
added some caveats.
1997-08-14 19:51:26 +00:00
Guido van Rossum 8f06247b51 Added buffer_info() docs. 1997-08-14 19:50:37 +00:00
Guido van Rossum 98046b90d0 Minor typo only. 1997-08-14 19:50:18 +00:00
Guido van Rossum fcaf26e245 Documented mime_decode_header() and mime_encode_header(). 1997-08-14 14:13:01 +00:00
Guido van Rossum 9c43c590bc More emphasis on os.environ's calling of putenv; and added hint about
flags for open().
1997-08-08 21:05:09 +00:00
Guido van Rossum fd16ca4542 Added mimify docs (Sjoerd). 1997-07-30 22:05:07 +00:00
Fred Drake bc0cd37fe2 l2h target: l2htut was listed twice and l2hapi was skipped. Fixed. 1997-07-30 15:59:25 +00:00
Fred Drake b065452ebc Bump up the version number. The date still needs to be set (Guido will
have to do that one!), but at least the version will match the release
version.  (1.5a2 got skipped for this.)
1997-07-25 13:14:35 +00:00
Fred Drake 12d9eac0a2 A couple of grammatical nits.
Re-sequenced the function descriptions so that the formatting is described
before the assumption is made that the reader has a clue about the formatting.

Moved examples to be closer to the functions being demonstrated.

Added example of saferepr() result.
1997-07-24 15:39:16 +00:00
Guido van Rossum 6576dd6ad6 Document new 'quote' flag to cgi.escape(). 1997-07-19 20:16:07 +00:00
Guido van Rossum 61c270345c added code.py; codehack.py is obsolete 1997-07-18 21:08:07 +00:00
Guido van Rossum 1c78cf3317 Added label{module-spam} 1997-07-18 21:07:34 +00:00
Fred Drake ca1182b262 Remove pprint from the list of undocumented modules. 1997-07-18 20:44:22 +00:00
Fred Drake d2b9f81ec5 Add entry for the pprint module. 1997-07-18 20:43:53 +00:00
Fred Drake 18600a4229 Add libpprint.tex to the lib.dvi dependencies. 1997-07-18 20:43:27 +00:00
Fred Drake ee8d3ca4cf Documentation for the pprint module. 1997-07-18 20:41:58 +00:00
Guido van Rossum b15e5ed689 Use 'and' instead of '&', which is a (La)TeX control character.
"make lib tut ext" should now be errorfree.
1997-07-17 18:30:15 +00:00
Guido van Rossum e3d5fc50a1 Add AMK's seealso environment that is now used in the library manual
at some places.
1997-07-17 18:27:53 +00:00
Guido van Rossum e47da0ae04 AMK's megapatch:
* \bcode, \ecode added everywhere
	* \label{module-foo} added everywhere
	* A few \seealso sections added.
	* Indentation fixed inside verbatim in lib*tex files
1997-07-17 16:34:52 +00:00
Guido van Rossum 3c2a056fdd Extensive changes by AMK. 1997-07-17 16:29:42 +00:00
Guido van Rossum 5320998da5 Note that getvalue() must be called before close(). 1997-07-17 16:29:04 +00:00
Guido van Rossum 0fcbe8dde2 Added libni.tex libgzip.tex 1997-07-17 16:27:42 +00:00
Guido van Rossum 41884a9b1c New from AMK 1997-07-17 16:26:11 +00:00
Guido van Rossum 0245569fd1 New version (interim) by AMK. 1997-07-17 16:21:52 +00:00
Guido van Rossum eb1633ec6e Removed mailbox, SocketServer, cmath -- these are now documented! 1997-07-17 16:21:18 +00:00
Guido van Rossum 84057a3874 Added cmath 1997-07-17 16:15:18 +00:00
Guido van Rossum 246d96555f Typo in example. 1997-07-17 16:14:12 +00:00
Guido van Rossum 14a8024b04 New cmath module docs, by AMK (with additions and deletions by Guido). 1997-07-17 16:13:45 +00:00
Guido van Rossum 6c9db41d30 Added fileno(); added readlines(sizehint).
AMK's sed job.
1997-07-17 16:05:47 +00:00
Guido van Rossum debf2e8a53 Fix dropped word. 1997-07-17 15:58:43 +00:00
Guido van Rossum cfaf143956 Added a few new undocumented modules. 1997-07-16 15:48:20 +00:00
Guido van Rossum 31cbc846ac Oops, some clarifications to conditional breaks. 1997-07-11 13:57:28 +00:00
Guido van Rossum 255d790077 Added (minimal) doc for conditional breakpoints.
(Lie about the syntax (and the syntax for "list") because latex2html
doesn't seem to handle doubly nested [] pairs.)
1997-07-11 13:51:17 +00:00
Fred Drake dd527332b7 fixed typo, "header" ==> "headers" 1997-06-20 16:55:08 +00:00
Fred Drake 8f81ef1edd Fix LaTeX bug found by examining the docstrings added to commands.py. 1997-06-12 16:14:07 +00:00
Fred Drake b4aeaebfe8 Added libcommands.tex to list of library reference dependencies. 1997-06-12 16:06:19 +00:00
Fred Drake 4fd1292c3c Documentation for Lib/commands.py, from Sue Williams. 1997-06-12 16:05:46 +00:00
Fred Drake 455838a217 Really nitty-gritty change to prevent latex2html from using a LaTeX-generated
image of the argument list....
1997-06-06 21:57:35 +00:00
Guido van Rossum 39a23cc1e3 Doc for mailbox.tex (Jack) 1997-06-02 21:04:41 +00:00
Guido van Rossum 6cb2ac226e A nicety (author lost). 1997-06-02 17:57:10 +00:00
Guido van Rossum 41c302fc68 add libmailbox 1997-06-02 17:36:12 +00:00
Guido van Rossum e5bb790027 Added libmailbox, obsolete libstdwin 1997-06-02 17:35:51 +00:00
Guido van Rossum daff175611 Increase printable page size. 1997-06-02 17:35:01 +00:00
Guido van Rossum b40f2a7446 Added SocketServer and mailbox modules. 1997-06-02 17:34:40 +00:00
Guido van Rossum 98b43eb012 It's now using mimetools instead of rfc822 1997-06-02 17:34:22 +00:00
Guido van Rossum b9ee9c2298 stdwin is obsolete. Point to bsddb from dbhash. 1997-06-02 17:34:02 +00:00
Guido van Rossum 0a3c7532f3 Additional info about sys.path, sys.version, sys.prefix, sys.exec_prefix.
(AMK)
1997-06-02 17:32:41 +00:00
Guido van Rossum 0fa066b72e Grammar (AMK). 1997-06-02 17:30:20 +00:00
Guido van Rossum 067a2acdf6 Mention seekable parameter (AMK).
Added pointer to mailbox module.
1997-06-02 17:30:03 +00:00
Guido van Rossum bac80022e4 Mention use of profile.py to run a script (AMK). 1997-06-02 17:29:12 +00:00
Guido van Rossum f967bf63f8 Added putenv, ftruncate (AMK). 1997-06-02 17:28:51 +00:00
Guido van Rossum 809408eb90 Mention use of pdb.py to run a script (AMK). 1997-06-02 17:28:16 +00:00
Guido van Rossum 94adab5e17 Added date, xgtitle, xover, xpath (AMK). 1997-06-02 17:27:50 +00:00
Guido van Rossum a3f53cde37 It's now using mimetools instead of rfc822 1997-06-02 17:26:30 +00:00
Guido van Rossum 2525bedfc0 Fix a sentence which ends "...is 6, which." (AMK) 1997-06-02 17:22:06 +00:00
Guido van Rossum 921f32ce4c Mention abs(complex) -> magnitude (AMK).
Documented list().
Mention [raw_]input()'s interface to GNU readline.
1997-06-02 17:21:20 +00:00
Guido van Rossum 3a0d850160 Added complex numbers (AMK).
Clarify that sort() works in-place.
Renamed dict.absorb() to dict.update().
1997-06-02 17:18:00 +00:00
Guido van Rossum 6102b51f2b Added copy() and absorb(). 1997-05-28 19:32:11 +00:00
Guido van Rossum 36f3502151 Added cvardesc and ctypedesc macros, for api.tex. 1997-05-22 20:43:24 +00:00
Guido van Rossum ae110af13b Just another checkin for backup. Nothing substantial yet. 1997-05-22 20:11:52 +00:00
Guido van Rossum 7806c16650 generated from latest doc files 1997-05-21 14:48:15 +00:00
Guido van Rossum 2335c5eaec Added description of socket_type. 1997-05-21 14:41:42 +00:00
Guido van Rossum 6181e00667 Added AMK's SocketServer docs. 1997-05-19 19:55:16 +00:00
Guido van Rossum 9231c8f176 Made a start with api.tex, the Python-C API Reference Manual.
Removed extref.tex (which provided the starting point).
Also removed qua.tex, which is out of date and no longer needed.
1997-05-15 21:43:21 +00:00
Guido van Rossum 1681429ba8 Fix the date. 1997-05-09 02:25:55 +00:00
Guido van Rossum 51a6c9055c Added docs for dumbdbm (AMK), and misc small fixes. 1997-05-09 02:23:45 +00:00
Guido van Rossum 7e691de948 Document return value of wait[pid]() more carefully.
Document how to get exit status of a popen() command.
1997-05-09 02:22:59 +00:00
Guido van Rossum e4f347e779 Document "" and "<broadcast>". 1997-05-09 02:21:51 +00:00
Guido van Rossum d0e8436e19 ??? maybe window size 1997-05-08 23:39:55 +00:00
Guido van Rossum 881255223d Added assert statement. 1997-05-08 23:39:31 +00:00
Guido van Rossum d8f038ec0a Added assert resword. 1997-05-08 23:39:12 +00:00
Guido van Rossum 4408ed5dcb Tiny utility prints the latest set of reserved words. 1997-05-08 23:21:48 +00:00
Guido van Rossum 78b21cf47a Checking in old changes -- no idea why (probably window size). 1997-05-08 23:21:09 +00:00
Guido van Rossum 5bbf0f7c93 Some updates (AMK at work, added resource.c). 1997-04-30 19:41:48 +00:00
Guido van Rossum dfb4120ea1 Add zlib 1997-04-30 19:40:10 +00:00
Guido van Rossum 412154f3c7 Updated web ref and version#. Folded some long lines. 1997-04-30 19:39:21 +00:00
Guido van Rossum 04bc9d6e67 zlib by AMK 1997-04-30 18:12:27 +00:00
Guido van Rossum e9a0732cd1 Note that passing a filename to uu.{en,de}code() is deprecated. 1997-04-27 21:29:51 +00:00
Guido van Rossum e76b7a8fcd Added fnmatch, base64 and quopri, received from Andrew Kuchling. 1997-04-27 21:25:52 +00:00
Guido van Rossum 150853861a Various status updates. 1997-04-03 23:49:28 +00:00
Guido van Rossum fc5ee0f980 Added site 1997-04-03 22:43:02 +00:00
Guido van Rossum 571391b963 New stuff by AMK. 1997-04-03 22:41:49 +00:00
Fred Drake 387c575d5c Small grammatical touchups:
Para. 1:  ...that reads and writes a string buffer...
			      ^		 ^

	Para. 3:  ...can be called at any time to retrieve the...
				  XXXXXXXXXXXX       ^^^^^
		  ...entire contents of the entire ``file'' ...
		     ^^^^^^^		   XXXXXXX

Guido, I hope I'm not stomping too far afield, but these seem pretty clear
to me.
1997-04-02 14:51:56 +00:00
Guido van Rossum f643e3ff7e Spell Unix, not UNIX. 1997-04-02 06:06:03 +00:00
Guido van Rossum e8d94a8c10 Horrible hack to split up code '--' to prevent
latex2html from collapsing it into '-'.
1997-04-02 06:05:07 +00:00
Guido van Rossum 1cd26f2fc0 Add complex().
Update int(), long(), float() to support string conversions.
1997-04-02 06:04:02 +00:00
Guido van Rossum 740eb8265f Add cross-refs for int() to atoi() etc.
Change replace() arguments; remove replace1().
1997-04-02 05:56:16 +00:00
Guido van Rossum 8d2893b5b2 Added a list of the main undocumented extension modules. 1997-03-27 20:57:52 +00:00
Guido van Rossum 7f3b0421de Added docs for UserDict,UserList 1997-03-27 14:56:18 +00:00
Guido van Rossum b6a80262e1 Added docs for glob and mailcap 1997-03-25 22:09:18 +00:00
Guido van Rossum e6d579ddbc Added docs for glob 1997-03-25 22:07:53 +00:00
Guido van Rossum 20af95b433 Added docs for mailcap 1997-03-25 22:01:35 +00:00
Guido van Rossum c8a80cdbad Added docs for replace() and replace1(). 1997-03-25 16:41:31 +00:00
Guido van Rossum e8e87999ab Remove untrue statement about . and .. being included in list of names
passed to walk() visitor.
1997-03-25 15:25:54 +00:00
Guido van Rossum 7b7c578616 Add optional 4th argument to [r]find and [r]index (end of slice). 1997-03-14 04:13:56 +00:00
Guido van Rossum 612316f016 Add a rough list of undocumented stuff at the end. 1997-03-14 04:12:52 +00:00
Guido van Rossum 1f8cee2521 Hint about [\] trick to avoid quad backslashes. 1997-03-14 04:10:13 +00:00
Guido van Rossum 3978d75cca Added intern() 1997-03-03 16:03:27 +00:00
Guido van Rossum 38e2ec4f14 Added ref to StringIO docs. 1997-03-03 16:03:05 +00:00
Guido van Rossum 3ff7317857 Correct two typos 1997-03-03 16:02:32 +00:00
Guido van Rossum d90e5b1012 Fix name of PyObject_GetAttrString 1997-03-03 16:02:10 +00:00
Guido van Rossum cda3d7d0e7 Added (minimal) StringIO docs. 1997-03-03 16:01:21 +00:00
Guido van Rossum 20e4210ec4 Fix up indentation of examples to use 4 spaces instead of tabs. 1997-02-28 16:37:49 +00:00
Barry Warsaw 7574587587 Document the new join() semantics. 1997-02-18 21:53:53 +00:00
Barry Warsaw 736bb0659f Added a paragraph to describe clear_cache(), and why it's necessary. 1997-02-18 18:59:37 +00:00
Barry Warsaw cd77df64e6 Document the new get_syntax() function. 1997-02-18 18:54:30 +00:00
Guido van Rossum 6fb6f10a96 Added doco for ratecv. 1997-02-14 15:59:49 +00:00
Guido van Rossum 7e924dd10d Correct typo in PyArg_ParseTuple example.
Add reference to DLD 3.3 at http://www-swiss.ai.mit.edu/~jaffer/DLD.html.
1997-02-10 16:51:52 +00:00
Fred Drake 43d287ad73 (libparser.tex): Fix typo found by Mark Hammond. 1997-01-22 14:25:21 +00:00
Guido van Rossum 5cd752028c Describe new ("unsigned") behavior of hex() and oct(). 1997-01-14 18:44:23 +00:00
Guido van Rossum fe27a50847 Added warning that gethostname() doesn't always return fqdn, and show
how to find it using gethostbyaddr().
1997-01-11 17:04:56 +00:00
Guido van Rossum 0d2971badb Document that sys.builtin_module_names is now a tuple. 1997-01-06 23:01:02 +00:00
Barry Warsaw d44be3fdb7 very minor typo 1997-01-03 20:19:05 +00:00
Guido van Rossum 653071731a 'I' and 'L' now always return a Python long. 1997-01-03 19:21:53 +00:00
Guido van Rossum b0b8181622 Added unsigned data formats (B, H, I, L). 1997-01-03 19:20:52 +00:00
Guido van Rossum dbadd558b5 Describe standard float/double support.
Rewrite example to be an interactive session
1997-01-03 04:20:09 +00:00
Barry Warsaw 6717030dc9 setkey method's argument is no longer optional (it used to be a no-op
when missing).
1997-01-02 19:48:00 +00:00
Fred Drake 591bbb1572 (libformatter.tex): Document the flush() method on the writer. 1996-12-31 20:51:42 +00:00
Guido van Rossum 3dd68d3364 Added libstat.tex 1996-12-31 02:24:54 +00:00
Guido van Rossum 125434665b Document the new extensions. 1996-12-31 02:22:14 +00:00
Barry Warsaw f308c0f1fc From reading the source, it turns out that the setkey() method can
take an optional string key, but if key is not given, the method does
nothing!  In the rewrite (see upcoming check-in), I left things this
way, but here I document that this is the case.
1996-12-23 23:34:17 +00:00
Barry Warsaw e5a43a405d Describe open(2) exported constants 1996-12-19 23:50:34 +00:00
Guido van Rossum e8e9ed176f Docs for stat.py -- docs by Skip Montanaro. 1996-12-19 22:39:22 +00:00
Barry Warsaw fa5a6cff45 posix.open(): third argument (mode) is optional. 1996-12-19 22:38:56 +00:00
Guido van Rossum 62ac99ebf5 Documented getprotobyname() interface. 1996-12-19 16:43:25 +00:00
Fred Drake ae0cd0b9b3 (libunix.tex): Change matching lib.tex: add line item for the resource
module.
1996-12-19 12:20:54 +00:00
Guido van Rossum 39900421bf Added pointer to framereader distribution. 1996-12-18 19:55:49 +00:00
Guido van Rossum 3c7b2dc02c Added docs for Jeremy's resource module. 1996-12-18 18:37:05 +00:00
Fred Drake 63a0c376ea (libunix.tex): Changed two occurances of "Unix" to "\UNIX{}". 1996-12-16 22:12:33 +00:00
Fred Drake 094579e677 (libtime.tex): Merged in changes from Tamito Kajiyama.
(For those watching Python CVS messages:  I checked in all of
	Tamito's other changes, but the mail delivery failed since the
	subject line was too long.  The patch Tamito sent for the
	documentation has been completely merged in.)
1996-12-13 22:09:52 +00:00