Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
7,797 Commits 6 Branches 593 Tags 2.8 GiB
Commit Graph

1279 Commits

Author SHA1 Message Date
Guido van Rossum c57aff20e3 Replace $math$ with \code{}. 1998-02-11 22:33:28 +00:00
Guido van Rossum c4452fd08f Swap ni and imp (so they are in the same order as their sections are). 1998-02-11 22:32:23 +00:00
Guido van Rossum 34122fa99c Remove a spurious space from the title. 1998-02-11 22:31:54 +00:00
Fred Drake ed68854b40 "lists objects" --> "list objects" (Section "More on Lists".) 1998-02-11 22:29:17 +00:00
Fred Drake 8d486b1779 In the appendix, all sections were marked as subsections, and so had section 
numbers "A.0.#".  Fixed.
 1998-02-11 22:12:18 +00:00
Fred Drake 5d8f0edc33 Add copyright.tex and boilerplate.tex to the common dependencies for .dvi 
files.
 1998-02-11 14:43:38 +00:00
Fred Drake a28eb3a8cb Mark the URL "ftp://ftp.python.org" with \url{}. 1998-02-11 14:42:06 +00:00
Fred Drake 4254363f25 &do_cmd_rfc: New function. Handles \rfc{}. 
$STRIP_INDEX_TT:  New flag.  If set, the <tt>...</tt> around stuff in the index
	is dropped.  This is more O'Reilly-like.

&make_str_index_entry:  Honor $STRIP_INDEX_TT.

&make_mod_index_entry:  Honor $STRIP_INDEX_TT.
 1998-02-10 22:11:07 +00:00
Fred Drake 526467ce0a Removed all references to the \rfcindex{} macro; now only \rfc{} is used. 1998-02-10 21:42:27 +00:00
Fred Drake a94d21f44e Minor performance nits. 1998-02-10 21:35:49 +00:00
Fred Drake 4be00713b8 Include indfix.py script in lib.dvi's processing. 1998-02-09 22:18:42 +00:00
Fred Drake dd244a0b9e Script to fix up the Library Reference index so it's less ugly. The docstring: 
"""Combine similar index entries into an entry and subentries.

For example:

  \item {foobar} (in module flotz), 23
  \item {foobar} (in module whackit), 4323

becomes

  \item {foobar}
    \subitem in module flotz, 23
    \subitem in module whackit, 4323

Note that an item which matches the format of a collapsable item but which
isn't part of a group of similar items is not modified.
"""

This results in a much more readable index, with less repitition of text;
especially for common method names.
 1998-02-09 22:17:52 +00:00
Fred Drake 1624a507e6 Oops, missed a \POSIX{} in an index entry. 1998-02-09 22:12:28 +00:00
Fred Drake 88223904c8 Add some index entries; switch to logical markup. 1998-02-09 20:52:48 +00:00
Fred Drake 65b32f7f74 Consistently use \POSIX{} to denote POSIX. There were at least two different 
ways to do it previously (not counting module names).
 1998-02-09 20:27:12 +00:00
Fred Drake 41785fb864 Do the right magic to make \ABC{} get sorted correctly in the index. 1998-02-09 20:16:46 +00:00
Fred Drake 19b97b13fa Do the right magic to make \UNIX{} get sorted correctly in the index. 1998-02-09 20:16:18 +00:00
Fred Drake c58912426e Use the new RFC macros wherever RFCs are referenced by number. No other 
changes.
 1998-02-09 19:16:20 +00:00
Fred Drake b16166e56f Add macros to insert RFC references much like the \manpage{} macro. Also a 
macro to insert an RFC index reference.

(RFC references were formatted three different ways.)
 1998-02-09 19:14:54 +00:00
Guido van Rossum 8083c176a3 Add a note about rounding up of readlines()' sizehint to 8K. 1998-02-08 22:51:09 +00:00
Guido van Rossum 6e91c6a344 Document getrefcount(). 1998-02-07 21:17:05 +00:00
Fred Drake b37a395231 \itembreak, \itemjoin: Remove unused macros. 
\idxcode{}:  New macro; used to mark things that would be \code{} for entry
	into the index.  This allows easily switching things around for the
	font used in the index.  (O'Reilly seems to keep it all plain roman
	in the index.  Looks reasonable in the Python documentation as well.)

\*index{}:  Use \idxcode{} instead of {\codefont{}}.
 1998-02-06 22:52:52 +00:00
Fred Drake 31c4ed75fc Remove commented-out \itembreak. 1998-02-06 22:26:04 +00:00
Fred Drake c660233cfb Update two of the \indexsubitem values to use singular rather than plural form 
of "variable": each individual variable should be identified as a single
variable and not a collection in the index.
 1998-02-06 22:19:23 +00:00
Guido van Rossum 8e1e68de49 Add ref to errno module, and change ref to posix.error to os.error. 1998-02-06 15:18:25 +00:00
Guido van Rossum f499e09f94 Add ref to errno module. 1998-02-06 15:18:05 +00:00
Guido van Rossum afcd589027 Retract the statement that all functions called by Python (even method 
defs) need to be declared extern "C" -- it seems to have no basis in
truth (any more?).
 1998-02-05 19:59:39 +00:00
Fred Drake 6b7fc6f267 Add *.pdf files to the clobber target (same target as *.ps). 1998-02-04 20:33:13 +00:00
Fred Drake baf700f398 Tell CVS to ignore PDF files. 1998-02-04 20:27:39 +00:00
Fred Drake b6e5032d9c Added description of "D" format for PyArg_ParseTuple(), including example 
use with function name provided as well.

Wrapped up PyArg_ParseTupleAndKeywords() description and provided example
based on Geoff Philbrick's example to the mailing list.
 1998-02-04 20:26:31 +00:00
Fred Drake 126d840d1a Use implicit rules to perform DVI->PS and PS->PDF conversions. PDF conversion 
requires "distill" from a FrameMaker installation.  ;-)  Would probably need
to be different for Windows/Mac.
 1998-02-04 19:54:40 +00:00
Fred Drake b19274704f \modindex{}: New macro; index module without declaring it "built-in" or 
"standard".  This is mostly for documentation of modules outside the
	standard library.
 1998-02-04 14:43:36 +00:00
Fred Drake 8aad4c80b3 Added missing "{" for "\code <?stuff?>}". 1998-02-03 23:12:13 +00:00
Guido van Rossum ad37e9e77d Clarify that capwords() removes leading/trailing whitespace. 
Remove references to regsub, which is obsolescent.
 1998-02-02 03:01:10 +00:00
Guido van Rossum c45c2f3dc1 Add S_ISBLK(). 1998-01-29 22:03:41 +00:00
Guido van Rossum 02505e4850 New version of xmllib from Sjoerd. 
The main incompatibility is that the error reporting method is now
called as
 parser.syntax_error(msg)
instead of
 parser.syntax_error(lineno, msg)

This new version also has some code to deal with the <?xml?> and
<!DOCTYPE> tags at the start of an XML document.
The documentation has been updated, and a small test module has been
created.
 1998-01-29 14:55:24 +00:00
Guido van Rossum 7570669a08 Add a note explaining that multiplying a sequence with a negative 
number is the same as multiplying it with zero, and yields an empty
sequence.
 1998-01-27 19:09:43 +00:00
Fred Drake c6c921a4de Py_AtExit(): Added brief note about the constraint on cleanup functions not 
calling the Python API.
 1998-01-26 19:16:27 +00:00
Fred Drake 16f88454f1 Use \url{} to mark a URL. 1998-01-22 20:47:26 +00:00
Fred Drake ff3f0d0a5c Use \url{} to mark URLs, \email{} to mark an email address. 1998-01-22 20:45:31 +00:00
Fred Drake ca6567fb3f Use \url{} to mark URLs. 1998-01-22 20:44:18 +00:00
Fred Drake 301ad2ee63 Fixed indexing of {datadesc} environments. 
Removed " (byte code instruction)" from the output of the {opcodedesc}
environment; this should only appear in the index (which it now does).

Removed some really old cruft related to otherwise removed debugging code.
(I *think* assignments to $* set & clear auto-flush of <STDOUT>, but don't
really remember.  Removing them seems to not change anything!)
 1998-01-22 18:14:39 +00:00
Fred Drake 0f02628dce \seemodule{}: Use logical markup for the module name, to ensure it picks up 
any changes introduced there.  Also ensure a little more space between
	the module name and the parenthesized comment.
 1998-01-22 17:43:15 +00:00
Fred Drake 7c418ed89c Added descriptions for log() and log10(). 
Clarified that floor() and ceil() return reals.  Same for the integer part
returned by modf().

Some markup consistency changes.
 1998-01-22 17:37:50 +00:00
Fred Drake bceaf35a63 Add support for the new macros, including hyperlink generation for \url{}. 1998-01-22 16:13:44 +00:00
Fred Drake ed79783bb2 Converted to use new macros. This example demonstrate \method{} and, more 
importantly, \url{}.
 1998-01-22 16:11:18 +00:00
Fred Drake 55f4492859 Converted to use semantic markup. This is an example of how many of the new 
constructs should be used.
 1998-01-22 15:56:41 +00:00
Fred Drake dd28d57fd0 Revised new macros after discussion with Guido: Always use full names of 
semantic concepts.

Added two new ones (not discussed with Guido:

\constant{}:  Markup for constants defined in Python modules.

\cfunction{}:  Markup for C functions; these should probably be distinguished
	by font, but are not at this time (since they're typically \code{} at
	this point).
 1998-01-22 15:55:21 +00:00
Fred Drake 0f35495563 Add entry for copy_reg module. 1998-01-21 05:04:52 +00:00
Fred Drake 6eb9f10063 Removed entry for copy_reg module. 1998-01-21 05:00:28 +00:00
Fred Drake 251fed3e56 $(LIBFILES): Added libcopyreg.tex. 1998-01-21 04:59:44 +00:00
Fred Drake 2d754437d4 Add entry for copy_reg module. 1998-01-21 04:58:39 +00:00
Fred Drake 1abf0df5b4 Simple documentation of the copy_reg module. 
Guido, you should probably look at this.  The pickle documentation is out of
date; I don't see anything about the __reduce__() stuff or the
__safe_for_unpickling__ attribute.
 1998-01-21 04:58:10 +00:00
Fred Drake d1cc9c2b92 Update comment about relative URL internet draft to reflect current RFC status; 
index references the appropriate RFCs.

Consistency:  Always use trailing "()" on function names in running text.
 1998-01-21 04:55:02 +00:00
Fred Drake 61b0452626 Added a bunch of "concept" index entries. 
Use trailing "()" on function names in running text.
 1998-01-20 05:52:23 +00:00
Fred Drake a46f84d293 Added index entry and \label{} for exceptions module. This isn't in the 
normal modules portion of the manual, but that's the basic effect of this
section with the 1.5 change in exception support.
 1998-01-20 05:26:12 +00:00
Fred Drake 73a973bf8d Always mark variables in the "Notes" following a table the same way as in the 
tables:  \var{}

Add a couple of index entries to the File Objects section.
 1998-01-20 05:20:39 +00:00
Fred Drake cbe50f4829 Removed bogus index entry for the type() built-in. 
Marked title of the Python Reference Manual as \emph{}, like other Python
manual titles.
 1998-01-20 05:12:36 +00:00
Fred Drake 311c19688d Proposed new macros: see comments. These are not yet used. 
These are intended to support semantic markup.  There are a number
	of places in the documentation where the exact meaning of an
	indentifier marked \code{} in the running text is ambiguous (could
	be a module or a class, a function or a method, etc.).  These are
	intended to clarify the intent of the identifier for processing
	applications and more intelligent style processing.
 1998-01-20 05:07:19 +00:00
Fred Drake cb42f7c295 Consistency: "{\tt ...}" ==> "\code{...}" 1998-01-20 04:55:47 +00:00
Fred Drake 9eb5e5097e Consistency: "{\it ...}" ==> "\emph{...}" 1998-01-20 04:54:23 +00:00
Fred Drake c520b695fe The soundex module is built-in, not standard. 
"--" ==> "---"
 1998-01-20 04:45:44 +00:00
Fred Drake ca12b9df7b Consistency: {\it ...} ==> \emph{...} 1998-01-20 04:43:29 +00:00
Fred Drake dd17d1ce62 ni is a standard module, not a built-in module. The only other reference to 
it already got it right.
 1998-01-20 04:40:41 +00:00
Fred Drake bac354cd80 Consistency: (Yes, I know this section is not formatted by default, and 
isn't likely to be of much interest these days....)

{\tt ...} ==> \code{...}

Added \label{module-blat} for the two supporting modules.

Added index entries for referred-to modules.
 1998-01-20 04:32:09 +00:00
Guido van Rossum 79a6a9e882 Removed a confusing note about coercions and __r*__ operators. 1998-01-19 23:16:55 +00:00
Guido van Rossum 46503922a0 Various updates to the effect that the group argument is always optional. 
Also documented that groups() now always returns a tuple.
 1998-01-19 23:14:17 +00:00
Guido van Rossum 7d4ecb8785 Add note about dropping latex 2.09 compatibility. 1998-01-19 23:10:21 +00:00
Fred Drake 8095ebfc4a Consistency: Replaced 4 {\it ...} with \emph{...}. 1998-01-19 04:02:41 +00:00
Fred Drake 94e8f690dd Consistency: Replaced one {\tt ...} with \code{...}. 1998-01-19 02:55:11 +00:00
Fred Drake b6ce6427e8 Consistency: In two places, change {\it ...} to \emph{...}. 1998-01-19 02:51:02 +00:00
Fred Drake 53396f66c1 Consistency: In two \section{} headers, change {\tt ...} to \sectcode{...}. 1998-01-19 02:48:37 +00:00
Fred Drake 9e24309bb5 \funcitem{}, \dataitem{}, \excitem{}: Removed obsolete macros; there are no 
longer used anywhere.  Use the {*desc} environments instead.

\var{}:  Ensure that the argument is always set in roman italic, in case an
	 alternate font is being used for code.  These keeps the result of
	 \var{} consistent.

Some minor changes to allow easier exploration of alternate fonts for code in
the running text.  Haven't changed the selected font; I haven't found one that
has everything required!  (The best non-monospaced font so far was missing
the <, >, and | characters, or at least had them at the wrong locations.  It
also allowed confusion between upper-case I and lower-case L.)
 1998-01-18 05:09:54 +00:00
Fred Drake b660b63edf Use \emph{} for all references to the other documents, not just some of them. 1998-01-16 16:34:34 +00:00
Fred Drake 5081b227f1 Ouch: "accounces" ==> "announces" 
(In description of AbstractWriter class.)
 1998-01-15 05:49:00 +00:00
Fred Drake af8a015c93 Consistency: "{\bf ...}" ==> "\strong{...}" 
"{\em ...}" ==> "\emph{...}"

	      Not at all sure what to do with "{\rm ...}".
	      Leaving it for now.
 1998-01-14 14:51:31 +00:00
Fred Drake b215137224 Added the standard \label{module-*} for the two supporting modules. 1998-01-14 05:47:15 +00:00
Fred Drake 8ac34c2928 Consistency: "Unix" ==> "\UNIX{}" 
Always include the comma *inside* the \optional{} markup!
 1998-01-13 22:41:33 +00:00
Fred Drake 737e73ec3d Augment \tableofcontents to do the right thing. 1998-01-13 22:40:08 +00:00
Fred Drake 4d4f9e726a Removed \mytableofcontents; just use \tableofcontents. 1998-01-13 22:25:02 +00:00
Fred Drake 3e9ce54eff Removed one hack! 1998-01-13 22:23:30 +00:00
Fred Drake a809064166 Consistency: "Unix" ==> "\UNIX{}" 1998-01-13 19:10:02 +00:00
Fred Drake 6862b46b70 Consistency: "unix" ==> "\UNIX{}" 1998-01-13 19:03:36 +00:00
Fred Drake c9dc5151b6 Consistency: "unix" ==> "\UNIX{}" 
Added \label{} for referring to the module.
 1998-01-13 19:01:57 +00:00
Fred Drake efc1e0f43b Consistency: 
"Unix" ==> "\UNIX{}"
 1998-01-13 19:00:33 +00:00
Fred Drake 3f20592c3e Consistency: 
"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"
 1998-01-13 18:56:38 +00:00
Fred Drake b0a78738ea Consistency: 
"Unix" ==> "\UNIX{}"

"C" ==> "\C{}"

"C++" ==> "\Cpp{}"
 1998-01-13 18:51:10 +00:00
Fred Drake 18f9f539f2 Removed obsolete \kwindex{} call. 
Added "user configuration file", ".pythonrc.py file" to the index.

Made reference to site module a {seealso} environment.
 1998-01-13 18:45:34 +00:00
Fred Drake 2b67bee8e1 Added "module search path" to the index. 1998-01-13 18:35:51 +00:00
Fred Drake cf75754357 Removed obsolete \kwindex{} calls. 
Added "module search path" to the index.

"Unix" ==> "\UNIX{}"
 1998-01-13 18:34:40 +00:00
Fred Drake bc5062f664 \kwindex{}: Removed obsolete macro. 1998-01-13 18:31:39 +00:00
Fred Drake b5dac4e02e &do_cmd_kwindex: Removed obsolete function. 1998-01-13 18:30:31 +00:00
Fred Drake 8362d005cf Added command at end to use times fonts; commented out. Instructions to use 
times are there as well.

Doing it here means the switch only affects one file and gets everything
rebuilt as needed.
 1998-01-13 17:29:31 +00:00
Fred Drake 95810e4d18 Removed tarps2, tardvi targets based on comments from Guido. 
Added -9 option to gzip.  This doesn't save much space, but it's "free" and
appreaciated by those with slow modems.  (With these tarballs, that means
"those with modems"...!)

Remove the two tarballs in the clean target.
 1998-01-13 17:18:57 +00:00
Fred Drake 657cb148c3 After discussion with Guido, agreed to only support double-sided PostScript, 
so we'll not need this shell whackery after all.
 1998-01-13 16:57:13 +00:00
Fred Drake dca8792b52 Added openright option the the \documentclass{} for each of the manuals. 1998-01-13 16:53:23 +00:00
Fred Drake 33d05b9d88 Added targets: 
tarps - one-sided PostScript
  tarps2 - two-sided PostScript, with ref.ps added as-is.
  tardvi - yes, some people want the .dvi files

  all-ps2 - Create the .ps files, but make sure the LaTeX openright option
	    is used in the \documentclass.
 1998-01-13 16:33:09 +00:00
Fred Drake bc3b1c6fce Script to add & remove LaTeX \documentclass options. Run "./texoption.sh" 
for usage information.
 1998-01-13 16:29:08 +00:00
Fred Drake ab0b65d0c9 &make_mod_index_entry: Wrap a long comment, store the additional data needed 
to create a module index in the HTML version.
 1998-01-13 04:05:11 +00:00
Fred Drake 9b6f1d24f9 Override several functions from the stock latex2html to support the module 
index.  It works, it's ugly, and would probably have to be completely redone
if we changed latex2html versions.  See the comments.  ;-(

On the other hand, it works.  ;-)

(Wait for myformat.perl checkin as well.)
 1998-01-13 04:03:02 +00:00
Fred Drake 1af9e79708 Added support for \funcline{} and \dataline{}. 
For all generated cases of <strong>...</strong> (from this module), change to
<b>...</b>.  This, from me?  This is entirely to reduce the size of the
generated markup, which is more of an issue than semantics here.  Since
<strong> isn't very meaningful anyway, this should be good.
 1998-01-12 23:15:29 +00:00
Fred Drake 023f87fbf8 Lots of minor markup nits, all consistency related. 
Consistently use trailing "()" on function / method names.

Wrapped some long lines.
 1998-01-12 19:16:24 +00:00
Guido van Rossum 97546399c7 Document maxsplit arg for split(), with incompatibility note about 1.5 
release bug.

Document groups() changed behaviour (now always returns tuple).
 1998-01-12 18:58:53 +00:00
Fred Drake 054f8fd12c Wrapped some long lines. 
Added trailing "()" for function and method names.

Added index entries for referenced modules.
 1998-01-12 18:28:20 +00:00
Fred Drake 74947ac473 Modify command descriptions to use \optional{} instead of ad-hoc markup. 
There are still weirdnesses, but less of them.
 1998-01-12 15:38:30 +00:00
Fred Drake 6c886a8db1 \optional{}: Removed leading word space, allowing more flexibility. 
{seealso} environment:  Always start a new paragraph after the "See Also:"
	line; this ensures that formatting is consistent for each subsequent
	\see*{} item.
 1998-01-12 14:44:33 +00:00
Guido van Rossum b2c45a8197 Sigh. Apply a similar patch to the *other* occurrence of [^...]. 1998-01-12 05:49:05 +00:00
Fred Drake fd49a964bc Follow current recommended practice in an example: Use isinstance() to 
perform a type test instead of type(x) == types.FoobarType.  In example
for type().
 1998-01-11 21:15:23 +00:00
Fred Drake 48022db400 "Unix" --> "\UNIX{}" 
Added index references to referred-to modules.

Added seealso section pointing to the glob module.

Removed description of translate().
 1998-01-11 19:06:37 +00:00
Fred Drake 0cf785a7a7 Grammatical nit. 1998-01-09 22:37:52 +00:00
Fred Drake cf7e830869 Add module reference for cPickle to index. 
Consistency:  Always use trailing "()" for function and method names in text.

Consistency:  Always mark parameter names with \var{} in text.

Change questionable text about CORBA to definate text about XDR; "CORBA" isn't
enough to specify an external representation, and I'm not sure the comment is
right if we say "IIOP".  I know its right about XDR if we only mention shared
object references and not recursive structures.
 1998-01-09 22:36:51 +00:00
Fred Drake 12d9da5827 Use \file{} instead of \code{} or ``\code{}'' to mark file & directory names 
& name parts.
 1998-01-09 22:30:32 +00:00
Fred Drake 8d0ff317bc Simplify markup. 1998-01-09 22:27:55 +00:00
Fred Drake 57b935d0d6 The resource module has been documented; remove from list. 1998-01-09 22:25:10 +00:00
Fred Drake bbe6068de0 Added \label{} to allow module references. 
Added some seealso sections.
 1998-01-09 22:24:14 +00:00
Fred Drake aa5dba026a Add index entry for reference to the math module. 1998-01-09 21:30:03 +00:00
Fred Drake d327a8dddf Typographical nits: Always set parameter names in \var{} in the running text. 1998-01-09 21:26:51 +00:00
Fred Drake 6b3ed7f581 Markup consistency in the mapping object interface description. 1998-01-09 20:36:44 +00:00
Fred Drake 0bf6845450 Fix previous nit to really do the right thing. 1998-01-09 16:26:54 +00:00
Fred Drake 60a3d2788e Consistency: Always use lower-case markup; one tag was still given in 
uppercase.  (Makes it easier to see what markup is generated by the
	Python manual support and what is generated by standard latex2html.)
 1998-01-09 14:39:41 +00:00
Fred Drake 0fd8268189 Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility 
mode) and take advantage of changes in myformat.sty.

Change "C" to "\C{}" and "\code{NULL}" to "\NULL{}" everywhere for consistency
and control.

Started a description of PyArg_ParseTupleAndKeywords().
 1998-01-09 05:39:38 +00:00
Fred Drake 1f8449af4e Revise prologue and frontmatter to use latex2e (not in 2.09 compatibility 
mode) and take advantage of changes in myformat.sty.
 1998-01-09 05:36:43 +00:00
Fred Drake 031ad4b2a0 \mytableofcontents New macro. Wrapper around \tableofcontents that 
does the right thing if the openright option is given.  Allows a
	lot of crud to be removed from the document files' frontmatter
	sections.

\endabstract		Extend standard macro.  (Called as \end{abstract}.)
	Does the right thing if the openright option is given.

\optional		Adjust to get the brackets right under latex2e.
 1998-01-09 05:34:23 +00:00
Fred Drake 46fbd7f4a0 Nit. 1998-01-09 05:22:44 +00:00
Fred Drake 3c3d7ce7fe For consistency, always use a trailing "()" on function names in the running 
text.

Add one index entry.
 1998-01-08 04:00:30 +00:00
Fred Drake fcda560e81 Fix a typo (the word "a" was spelled "c"!). 
Added index entries & \label{} constructs.
 1998-01-07 22:05:25 +00:00
Fred Drake c9a32ab26b Normalize some markup. 
Use \file{} instead of \code{} for a directory name (Tools/freeze).

Consistently use "()" at the end of a function name in running text.
 1998-01-07 18:57:01 +00:00
Fred Drake 6279fccf4c Fixed up index entries. 
Adjusted one formatting problem (long \code{} in running text).
 1998-01-07 13:23:32 +00:00
Fred Drake 1566a1d72c Added index entry for the protocol. 
Fixed typo (extra char in the word "character").

Minor nits.
 1998-01-07 13:17:20 +00:00
Fred Drake 15bac5d6e4 Added index items for the RFC and the protocol itself. 1998-01-07 13:13:42 +00:00
Fred Drake 799484399d Fixed index entries to be more consistent. 1998-01-07 03:47:10 +00:00
Fred Drake c4586387f6 In description of \D, revise markup so that the caret shows up in the HTML 
version as well as the dvi form.  Without the fix, it showed up as an extra
zero character.

Bug reported by Hugh Sasse <hgs@dmu.ac.uk>.
 1998-01-06 15:46:21 +00:00
Fred Drake 85a5c52752 Descriptions for PyRun_String(), PyRun_File(), and PyRun_CompileString() all 
gave the return type as part of the function field and used an empty return
type field.  Fixed.

Function name field for PyLong_FromString() included an asterisk at the
beginning of the function name field; removed.
 1998-01-02 03:24:19 +00:00
Fred Drake 34252f99d6 lib.dvi target: Added commands to generate the modules index. 1998-01-02 03:01:47 +00:00
Fred Drake c1ce320a4f Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
Fred Drake 0b1337d674 Add module index before the general index. 1998-01-02 02:59:09 +00:00
Fred Drake da941ef27c Added support for storing information to build a module index. 
Enhance the "theindex" environment to add an entry to the table of contents.
 1998-01-02 02:57:41 +00:00
Fred Drake 875c807c92 In description of the group() method, fix markup of "\(" and "\)" literals; 
"\code{\\(}" produces "(" in the .dvi file and "<BR> (" in the latex2html
output (the font was right).  Changed to "\code{{\e}(}" variation, which
fixes both.  Breaks the .texi file generation again.  Oh well.
 1998-01-02 02:50:13 +00:00
Guido van Rossum 3884e7edf9 Apply fixps.py to allow A4 paper printing. 1997-12-30 23:49:49 +00:00
Guido van Rossum 1f35977bfd Added BaseHTTPServer to table of contents for chapter. 1997-12-30 23:42:27 +00:00
Guido van Rossum eb0f066fb8 Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
Guido van Rossum ccd25d10c4 Final version for 1.5; two tiny corrections. 1997-12-30 18:35:35 +00:00
Guido van Rossum 5793039dce Clarify that __getinitargs__ is called at pickle time! 1997-12-30 17:44:48 +00:00
Guido van Rossum 4f80b65aa6 Added "docs" for Pareto and Weibull distributions. 1997-12-30 17:38:05 +00:00
Fred Drake 1c8b9e4769 Clean out *.texi and *.info* as well for "make clean". 1997-12-30 04:57:58 +00:00
Guido van Rossum 7779619524 Add obsolescence note. 1997-12-30 04:54:47 +00:00
Guido van Rossum b1b8f23903 Add URL of Andrew Kuchling's nifty re conversion page... 1997-12-30 04:53:49 +00:00
Guido van Rossum 8e94489882 Add a note that up to 1.4, translate() produced Emacs style syntax; in 
1.5, it produces Perl style syntax.  Also change "Python's regular
expressions" into plain "regular expression" in the intro.
 1997-12-30 04:43:36 +00:00
Fred Drake e33e903461 Updated release date to match boilerplate.tex. 
Removed implied future availability of an info/texi version of the other
manuals (the word "yet").

Guido, you might want to check this file to see if any other changes are
required.
 1997-12-30 04:42:49 +00:00
Guido van Rossum 5de1eb9b84 Added ConfigParser.py to list of undocumented miscellaneous useful utilities. 1997-12-30 04:41:56 +00:00
Guido van Rossum dccc298e3d Took out some disclaiming text (even from the title!). Rewritten 
abstract.  Alas, I didn't get to do anything else before the release
:-(
 1997-12-30 04:40:25 +00:00
Guido van Rossum 5b8a523538 A whole bunch of typos fixed by Andrew Kuchling. 
Added a warning about the incompleteness to the front.
Added a reminder about CObject to the back.
 1997-12-30 04:38:44 +00:00
Guido van Rossum 5b943ca1a9 Set the release date for 1.5 (final). 1997-12-30 04:29:30 +00:00
Fred Drake 13704a8928 Added .PHONY annotation for lib.info target; the real target is 
python-lib.info.  The annotation is needed to prevent at least GNU make from
building a second set of info files with the lib.info base name.
 1997-12-29 22:04:44 +00:00
Guido van Rossum e66e9c5562 Remove more commented-out text that is no longer needed. 1997-12-29 21:43:04 +00:00
Guido van Rossum 29d3b9368c Remove the commented-out warning at the top. It shouldn't be there 
for the 1.5 release version of the file.
 1997-12-29 21:42:03 +00:00
Fred Drake 43c9350f7a Getting uglier. But it doesn't completely bomb except for some table stuff. 
I'll get to it when I can.
 1997-12-29 21:40:35 +00:00
Fred Drake 78f8e98232 Lots of minor nits that allow this file to get processed without failures by 
the info generation phases.  Most of the errors had occurred in the makeinfo
step.

Commented out the warning at the top; this should still really be removed
before 1.5, but that's not my call.  It generated problems for the info
conversion as well.
 1997-12-29 21:39:39 +00:00
Fred Drake 6810a29c64 Ignore generated info files. 1997-12-29 21:37:21 +00:00
Fred Drake a007c13094 Reduce warning count from partparse.py. 
Removed BaseHTTPServer.py from list of undocumented modules.
 1997-12-29 21:32:26 +00:00
Fred Drake 3d913ad370 Revised lib1.texi target to deal with some conversion nastiness. See comment. 1997-12-29 21:31:23 +00:00
Fred Drake 1b6cf78c15 Reduce warning count from partparse.py. 1997-12-29 20:28:33 +00:00
Fred Drake 588f38ec2a Ignore another intermediate file from the info generation. 1997-12-29 20:03:46 +00:00
Fred Drake d7feffdd5f Reduce warning count from partparse.py. 1997-12-29 20:02:55 +00:00
Guido van Rossum 9cb64803aa Added Greg Stein's docs for BaseHTTPServer.py. 
Moved docs for "re" to before docs for "regex".
 1997-12-29 20:01:55 +00:00
Fred Drake b0744c5a28 Make "{" and "}" in code sample visible instead of a group (it's supposed to 
be a dictionary...).
 1997-12-29 19:59:38 +00:00
Fred Drake bef9b0b039 Added missing "\" to "\var{address}, var{length}" in buffer_info() description. 1997-12-29 19:33:45 +00:00
Fred Drake 6884e3b94b Reduce warning count from partparse.py. 1997-12-29 19:09:37 +00:00
Fred Drake c416445d7e Use tableii environment for the table instead of tabular. This makes it 
consistent with other 2-column tables in the Python documentation.
 1997-12-29 19:02:01 +00:00
Fred Drake 671fe9dd31 Reduce warning count from partparse.py. 1997-12-29 18:53:31 +00:00
Fred Drake a3e672b574 Nit adjustments to remove warnings when processed with partparse.py. 1997-12-29 18:21:37 +00:00
Fred Drake f0867315e9 Normalized the word "Unix" to "\UNIX{}". 
Changed "{\tt crypt}" to "\sectcode{crypt}" in section heading.
 1997-12-29 17:31:22 +00:00
Fred Drake a4541af0ba A bunch of minor stuff. 
Lots of support for new macros defined in myformat.sty; including the new
indexing macros, seealso environment & friends, and the byte code instruction
support.
 1997-12-29 17:19:22 +00:00
Fred Drake 05dd3c09ab Added back info generation. Still buggy in the final phase (makeinfo run). 
Does not conflict with any other targets.
 1997-12-29 17:17:54 +00:00
Fred Drake cc97454987 Added missing "\" to "var{P}.\var{M}" in load_module() description. 1997-12-29 17:16:24 +00:00
Fred Drake f3e6df1e2d Remove unneeded "{}" that confused makeinfo. 1997-12-29 17:11:55 +00:00
Fred Drake 6ccaaf1a08 Change name of temporary file to avoid possible filesystem issues; matches 
similar renaming of the @buildno file elsewhere in the Python tree.
 1997-12-29 16:58:46 +00:00
Fred Drake 1656d17c42 Changed all \verb\...\ markup to either \code{...} or \samp{...}. 1997-12-29 16:55:50 +00:00
Fred Drake 2cd0b9b1ba Removed "-*-texinfo-*-" from first line; this can cause emacs/xemacs to stop 
and ask the user for permission to set buffer-local variables depending on
the user's configuration.  Not really needed since this doesn't get edited
often.

Bumped the version number to 1.5; date still needs to be set.
 1997-12-29 16:54:11 +00:00
Fred Drake f9951818a6 Normalized the \seetext markup to match the only other instance: should be 
"\seetext{...}" instead of "\seetext ...".
 1997-12-29 16:37:04 +00:00
Fred Drake 45c9df6636 Changed some \verb\...\ markup to the more common \code{...}. \verb\...\ is 
rarely needed and should be avoided where possible since it doesn't behave
well with some processing tools (like partparse.py).
 1997-12-29 15:55:10 +00:00
Fred Drake 0ee358529e do_env_tableii(), do_env_tableiii(): Align the table in the center, just 
like LaTeX does.  There's no need to diverge on this.
 1997-12-28 03:41:07 +00:00
Guido van Rossum dd79bd3539 Checking in fixed PS, with A4 capability. 1997-12-24 18:32:36 +00:00
Guido van Rossum b9973d9060 Script to edit one line in the PS to allow A4 printing. 1997-12-24 18:31:53 +00:00
Fred Drake 7f96291ee2 Convert a couple of three-column tables with an empty third column to 
two-column tables.  This improves the rendering of the HTML version on
(at least) some browsers.
 1997-12-23 04:21:20 +00:00
Fred Drake d665e8b5b0 Removed unnecessary \small{} block; latex2html got it wrong and its no 
longer needed for printed output.
 1997-12-23 04:10:35 +00:00
Fred Drake d21759ba47 Removed unnecessary \small{} block; latex2html got it wrong and its no 
longer needed for printed output.
 1997-12-23 04:03:26 +00:00
Guido van Rossum 0148bbf966 AMK's latest 1997-12-22 22:41:40 +00:00
Fred Drake 9597daf220 do_env_tableii(), do_cmd_lineii(), 
do_env_tableiii(), do_cmd_lineiii():  New functions to handle tableii and
	tableiii environments.

Small changes to not add a superfluous space between a function name and the
comma in the index.
 1997-12-22 22:37:34 +00:00
Guido van Rossum e903aab833 Replace unprotected tilders by \~ -- an unprotected tilde is a 
non-breaking space!
 1997-12-18 16:28:56 +00:00
Fred Drake b2c6ef83f4 Change {\em ...} to \emph{...}; this seems to be the developing preference 
throughout the manuals, and seems easier to read.
 1997-12-18 15:56:05 +00:00
Fred Drake 616b23b2e4 img_tag(), top_navigation_panel(): Generate markup the same case as other 
functions in this file.
 1997-12-18 14:16:46 +00:00
Fred Drake 8da9e6a8a0 make_mod_index_entry(): Generate markup the same case as other functions in 
this file.
 1997-12-18 14:14:16 +00:00
Fred Drake 304474f315 Make the word "Module" in the section header start with an upper-case "M". 
Include "()" when naming functions in the text.

Fixed reference to the built-in str() function.

Format constant names using \code{}.
 1997-12-17 15:30:07 +00:00
Fred Drake 20417b7afb Make the word "Module" in the section header start with an upper-case "M". 
Added index entry for RFC 1014.
 1997-12-17 14:17:35 +00:00
Fred Drake b78da332fa Make the word "Module" in the section header start with an upper-case "M" 
for all three modules described here.

Added a \label{} for each of the two modules missing it.
 1997-12-17 14:12:31 +00:00
Fred Drake a47bce54a6 Make the word "Module" in the section header start with an upper-case "M". 
Added a \label{} for the module.

Fixed one minor grammatical nit:  use plural pronoun to refer to a pair of
referents.

Include "()" when naming functions in the text.
 1997-12-17 14:11:18 +00:00
Fred Drake 9c483191d6 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:08:01 +00:00
Fred Drake 2303d31cc0 Make the word "Module" in the section header start with an upper-case "M". 
Added a \label{} for the module.

Changed one \code{} to a \samp{}.
 1997-12-17 14:07:25 +00:00
Fred Drake bcda484bc4 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:01:52 +00:00
Fred Drake 36499b8e62 Make the word "Module" in the section header start with an upper-case "M" 
for both modules documented here.
 1997-12-17 14:01:31 +00:00
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