Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
9,001 Commits 6 Branches 592 Tags 2.4 GiB
Commit Graph

912 Commits

Author SHA1 Message Date
Fred Drake be2b6d7f42 Logical markup. 1998-03-14 06:40:34 +00:00
Fred Drake ff79a21119 Logical markup. 
Use {classdesc} environments to describe the constructors, and place them
at the top.
 1998-03-14 06:30:13 +00:00
Fred Drake cdea8a3c60 Logical markup. 
Wrap general Message class description in a {classdesc} instead of nothing at
all.
 1998-03-14 06:17:43 +00:00
Fred Drake 0f51fff57e Logical markup. 1998-03-14 06:16:57 +00:00
Fred Drake 3b5da76182 Logical markup. 1998-03-12 15:33:05 +00:00
Fred Drake 2dde74c778 Logical markup. 1998-03-12 14:42:23 +00:00
Fred Drake 51375ae07b Use {classdesc} instead of {funcdesc} for HTMLParser. 
Clean up index reference to SGMLParser class.
 1998-03-12 14:39:09 +00:00
Fred Drake 6ef871ce2f Logical markup. 
Lots of nits in both.
 1998-03-12 06:52:05 +00:00
Fred Drake 7be8fcb42a Use \envvar{FOO} instead of \code{\$FOO}. 1998-03-12 06:47:48 +00:00
Fred Drake 4e7e11abe5 Use \withsubitem{} for indexing extra-module functions. 1998-03-12 06:46:16 +00:00
Fred Drake 371ecc0c1b Use \withsubitem{} for indexing functions from other modules. This fixes 
things in the index.
 1998-03-12 06:44:58 +00:00
Fred Drake 6a1eefe535 Logical markup. 1998-03-12 06:04:53 +00:00
Fred Drake a2e9818467 Logical markup. 
Improve some index entries.
 1998-03-12 05:54:02 +00:00
Fred Drake c71585e069 Logical markup. 
Markup consistency.

Removed incorrect \setindexsubitem{}.
 1998-03-12 05:33:40 +00:00
Fred Drake bc8ad5bdeb Replace lists of attributes for code and frame objects with a reference to the 
Python Reference Manual.
 1998-03-11 06:29:59 +00:00
Fred Drake fdbd51db8b Logical markup. 1998-03-11 06:24:46 +00:00
Fred Drake 60ba44750f Logical markup. 1998-03-11 06:18:15 +00:00
Fred Drake 295eaa84b0 Logical markup. 
Changed example to use "import posixfile" instead of "from posixfile import *"
since only one symbol was used.
 1998-03-11 06:11:37 +00:00
Fred Drake e42f595e5c Logical markup. 
Made references to constants in other TERMIOS module explicit in termios
description.

Removed superfluous backslash from example.
 1998-03-11 06:00:23 +00:00
Fred Drake db9693ec97 Logical markup. 1998-03-11 05:50:42 +00:00
Fred Drake 75aae9ad89 Logical markup. 
Added information on the exception attributes when exceptions are classes.
 1998-03-11 05:29:58 +00:00
Fred Drake b30d0164bf Logical markup. 1998-03-10 05:41:08 +00:00
Fred Drake 4ef3329259 Logical markup. 
Correct misuse of indexsubutem.

Describe the Queue class using {classdesc}{Queue}, not {funcdesc}{__init__}.
 1998-03-10 05:32:30 +00:00
Fred Drake 8aee0e0356 Add some more labels for logical addressing. 1998-03-10 05:21:39 +00:00
Fred Drake d883ca1dcb Logical markup. 1998-03-10 05:20:33 +00:00
Fred Drake 193338afeb Logical markup. 
Convert one bulleted list to a {tableii} environment; the other should
probably be converted, but I haven't decided to what.
 1998-03-10 04:23:12 +00:00
Fred Drake 2cb1074937 Use a {datadesc} environment to describe errorcode. 1998-03-10 03:53:03 +00:00
Fred Drake 92f31f1260 Logical markup. 1998-03-10 03:38:31 +00:00
Fred Drake a44d74086c Logical markup. 
Use {funcdesc} and {excdesc} to describe the module, not just running text.
 1998-03-10 03:36:00 +00:00
Fred Drake c4f15af7de Logical markup. small nits. 1998-03-10 03:17:26 +00:00
Fred Drake 7d20ffe245 Adjust the index inclusion for the new index support. 1998-03-09 16:39:22 +00:00
Fred Drake 2eda4ca4df Markup adjustments. 1998-03-08 08:13:53 +00:00
Fred Drake cd14a87c02 Mark the journal title. 1998-03-08 08:02:58 +00:00
Fred Drake 23bc85a8a6 Correct spelling of emdash. 1998-03-08 07:56:48 +00:00
Fred Drake 7ddd043191 Moved solitary "see also" paragraph into a {seealso} environment, and told 
why the reader should see also.
 1998-03-08 07:44:13 +00:00
Fred Drake 013ad9869e Cleaned up some remaining markup nits. 
Andrew:  In description of (?iLmsx), you say it matches the empty string and
sets the corresponding flag.  Is this correct?  Or does it only set the flag?
 1998-03-08 07:38:27 +00:00
Fred Drake 8fab8cf211 Logical markup. 1998-03-08 07:14:20 +00:00
Fred Drake b991f8d2e0 Some logical markup. 1998-03-08 07:09:19 +00:00
Fred Drake b55f9d3dfc Small nits. 
Don't run into the right margin.
 1998-03-08 07:03:27 +00:00
Fred Drake cc444e39e5 Nits. 1998-03-08 06:47:24 +00:00
Fred Drake bccc64020e Logical markup. 
Spell emdash right.
 1998-03-08 06:41:57 +00:00
Fred Drake 0c2af2bef6 Spell emdash with three hyphens. 
Minor nits.
 1998-03-08 06:28:00 +00:00
Fred Drake 266b4c1506 Logical markup. 
Index entry.
 1998-03-08 06:12:10 +00:00
Fred Drake c07ae9f4d2 Some logical markup. 
Combine function pairs:  add() and __add__() go together.  This way they
share a single description and use less space.
 1998-03-08 05:56:15 +00:00
Fred Drake 0fd72ee369 Logical markup. 
Don't prepend the module name when referring to functions or data in the same
module.

Correct the description of "modules".
 1998-03-08 05:43:51 +00:00
Fred Drake 580eb26044 Logical markup, a couple of index entries. 1998-03-08 05:41:11 +00:00
Fred Drake 4074896a1e Add reference to the copy_reg module in the See Also: section. 1998-03-06 21:27:14 +00:00
Fred Drake 859c797a48 Fix the URL for the regex-to-re HOWTO. 1998-03-06 15:11:30 +00:00
Fred Drake 2135117542 Oops, I *thoughT* I had seen a better address for Andrew.... 1998-03-05 20:06:31 +00:00
Fred Drake 8b8eae3e68 Updated URL & email addresses related to the PCT. 
Andrew, plase check to make sure these are the ones you want used and get
back to me; this stuff will be "published" in the near future.
 1998-03-05 20:04:23 +00:00
Fred Drake 6659c30b67 Convert LaTeX support to create a new class of documents. HTML generation 
now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress).

This means that doing things to change the formatting of the manuals (at the
"normal user" level, like A4 paper), can happen in just one place, rather
than in each document file.
 1998-03-03 22:02:19 +00:00
Fred Drake 53525379da Logical markup. 1998-03-03 21:56:15 +00:00
Guido van Rossum 9bdc436aaa Added msvcrt. 1998-03-03 02:00:14 +00:00
Fred Drake 92e31944f4 Deprecate the read() and write() methods. 
Don't refer to them from the fromfile() and tofile() methods.
 1998-02-27 16:21:31 +00:00
Fred Drake 8a13525274 Updates by AMK. 
Markup corrected, logical markup.
 1998-02-27 15:19:42 +00:00
Fred Drake 8fa5eb8784 Logical markup. 1998-02-27 05:23:37 +00:00
Fred Drake 540e13dd1e Derive the name of the modules .ind from the jobname. 1998-02-25 15:31:20 +00:00
Fred Drake d10d0faaa5 Logical markup. 1998-02-24 21:43:05 +00:00
Fred Drake 78f6aac73e Clean up some stuff in the {seealso} at the end. This avoids a little nit 
(which causes processing to fail) when using the LaTeX hyperref package.
 1998-02-23 21:31:24 +00:00
Fred Drake a705da7aa0 Marked the unmarked AttributeError. (AMK) 
"Protect the class instance" --> "Protect the object"  It works for anything
with attributes to look up!  (AMK)

Logical markup.
 1998-02-23 14:42:00 +00:00
Fred Drake 71f894ad56 "streans" --> "streams" (AMK) 1998-02-23 14:37:40 +00:00
Fred Drake eb72a275b4 Add a period to "Written by James Roskind" 1998-02-22 20:42:11 +00:00
Guido van Rossum d028ca989a Fixed and extended the example; the original example contained some 
bogus code.
 1998-02-22 04:41:51 +00:00
Guido van Rossum 3ffb715032 Added two subsections with extra hints and details, even for 
extensions and embedding programs.
 1998-02-22 04:23:51 +00:00
Fred Drake 2c8aa650a8 Added \label{}s for logical addressing. 
Logical markup.
 1998-02-20 06:03:52 +00:00
Fred Drake d67e12e65c Added \label{}s for logical addressing. 1998-02-20 05:49:37 +00:00
Guido van Rossum 505d80b39d Jeff Kunce writes (and he is right): 
Also, I just ran across a [possible] minor glitch
in the library documentation for site.py. It says:

"For example, suppose sys.prefix and
sys.exec_prefix are set to `/usr/local'. The
Python 1.5 library is then installed in
`/usr/local/lib/python1.5'. Suppose this has a
subdirectory `/usr/local/python1.5/site-packages'
with three subsubdirectories, `foo', `bar' and
`spam'..."

I think it should be:
"...Suppose this has a subdirectory
`/usr/local/lib/python1.5/site-packages' with..."
          ^^^^
 1998-02-19 21:02:32 +00:00
Fred Drake 0cf0cfbaa9 Adjusted \label{} for *consistent* logical addressing. 
Logical markup.
 1998-02-19 20:59:19 +00:00
Fred Drake c83db33781 Added \label{} for logical addressing. 1998-02-19 20:50:52 +00:00
Fred Drake c3e4549012 Added \label{} for logical addressing. 1998-02-19 20:22:13 +00:00
Fred Drake 83efb54562 Added \label{} for logical addressing. 1998-02-19 20:07:39 +00:00
Fred Drake 83c1a39c4b Separate chapter and section. 1998-02-19 18:59:48 +00:00
Fred Drake 1aabe5e4d1 Separate binhex and binuu documentation from binascii. Support better 
module addressing in HTML.
 1998-02-19 18:29:18 +00:00
Fred Drake c92740708d Adjust grouping for the "b(reak)" command syntax description. This is 
required to get the info generation back in operation, yet again.
 1998-02-19 15:18:02 +00:00
Fred Drake 20e01966f5 Logical markup. 
Several uses of "\^" could be simplified; this fixes part of the info
generation process.
 1998-02-19 15:09:35 +00:00
Fred Drake ea8006a865 \nodename{} must immediately follow \chapter{} to be handled correctly; 
adding the \label{} broke that.
 1998-02-19 14:00:22 +00:00
Fred Drake 75bfb0f7bb {fulllineitems} is now an environment; use it as such. 1998-02-19 06:32:06 +00:00
Fred Drake 802a202d0d Logical markup. 
Changed {funcdesc} to {classdesc}.  This is a test case for {classdesc}.
 1998-02-19 06:26:35 +00:00
Guido van Rossum a73033fcc2 Feature added by Bill van Melle: when no timezone is present, assume 
local time -- that's better than failure.
 1998-02-19 00:28:58 +00:00
Guido van Rossum 026d9626df Consistent spelling: "time zone" -> "timezone". 
Clarify that the sign of the timezone offset returned by
parsedate_tz() is the opposite of time.timezone.
 1998-02-18 21:47:29 +00:00
Fred Drake b4efb6c8cb Separate Mac user interface modules into separate files, to better support 
bookmarkable module sections in the HTML.
 1998-02-18 17:19:11 +00:00
Fred Drake b0df567897 Separate the parse, symbol, and token documentation into separate files. 1998-02-18 15:59:13 +00:00
Fred Drake 710c035c05 Added \label{} for logical addressing. 1998-02-18 15:47:17 +00:00
Fred Drake 31ecd50d02 Added \label{} for logical addressing. 1998-02-18 15:40:11 +00:00
Fred Drake af0bfbee46 Added \label{} for logical addressing. 
Logical markup.
 1998-02-18 15:39:15 +00:00
Fred Drake 1f3ab1cb6c Added \label{} for logical addressing. 1998-02-18 15:22:08 +00:00
Fred Drake 55fca54ebb Added \label{} for logical addressing. 
Logical markup.
 1998-02-18 15:21:26 +00:00
Fred Drake 12918af83e Added \label{} for logical addressing. 1998-02-18 15:10:24 +00:00
Fred Drake ddf03bf8e1 Added \label{} for logical addressing. 
Logical markup.
 1998-02-18 15:05:47 +00:00
Guido van Rossum 1931c0c961 Add normpath(). Clarify normcase(). (Note -- this doc section 
probably needs more work, describing new functions and the differences
between unix/mac/win.
 1998-02-18 14:00:05 +00:00
Guido van Rossum 8cf94e608e Add mktime_tz(). Add () to a function reference in parsedate_tz(). 1998-02-18 05:09:14 +00:00
Fred Drake 57b5e42c0c Added \label{} for logical addressing. 1998-02-17 22:30:13 +00:00
Fred Drake e2f194b57d Use \manpage{} markup for referencing a UNIX man page. 
Added index entry for DES cipher.
 1998-02-17 22:24:45 +00:00
Fred Drake 8ecc705ba4 Added comment explaining the only warning produced by makeindex, since there 
doesn't appear to be a way to fix that's reasonable.
 1998-02-17 20:31:08 +00:00
Fred Drake 7154d382c3 Update indexsubitem for file attributes correctly. 1998-02-17 02:11:21 +00:00
Fred Drake a200faac55 \nodename{} must appear immediately after \section{} for the info conversion. 1998-02-17 02:10:41 +00:00
Fred Drake fac431e7d5 NNTP.xgtitle() description: Add a missing ")" from the response value 
description.

NNTP.xover() description:  Adjust some markup for consistency.
 1998-02-16 21:57:37 +00:00
Fred Drake 009ab92c12 Made the area for wildcards in the description wider, so we don't invade the 
left margin.
 1998-02-16 21:37:58 +00:00
Fred Drake 75fc045bf5 Fixed formatting of the program name for crypt. 
Added another index entry.
 1998-02-16 21:36:57 +00:00
Fred Drake ad51192a4f In the example file name, use the current Python version, not a hardcoded 
value.

Use logical markup.
 1998-02-16 21:25:53 +00:00
Fred Drake 2705e801d9 For the lists which describe the regular expression syntax, increase the 
width available so we don't run into the left page margin.
 1998-02-16 21:21:13 +00:00
Fred Drake b0f77d65db Use \version to get the current Python version number, where possible. This 
can only be done in the running text, and not in {verbatim} environments.
 1998-02-16 20:58:58 +00:00
Fred Drake 7506298dfb Mark up filename extensions consistently. 
Logical markup.
 1998-02-16 20:40:37 +00:00
Fred Drake b666c15c4a Normalization of markup. 1998-02-13 22:22:36 +00:00
Fred Drake 6e99adb1c9 Don't capitalize identifiers at the beginning of the sentence; re-write to 
place them elsewhere so they get the right capitalization.
 1998-02-13 22:17:21 +00:00
Fred Drake 01dbb88831 Fix some markup so that the right characters are printed. 
"EOF" --> "\EOF{}"
 1998-02-13 22:13:07 +00:00
Fred Drake 4a1efb63a9 Capitalize subsection title. 1998-02-13 22:10:21 +00:00
Fred Drake ab875b9a32 Make one paragraph wrap a little better. 1998-02-13 22:07:33 +00:00
Fred Drake a19bb9bbcf Capitalize first word in sentences, use periods at end. 1998-02-13 21:57:33 +00:00
Fred Drake 86b5dcec86 Change {datadesc} environments with empty descriptions to \dataline{}s; this 
removes extra vertical space from the list of names, and makes the display
more similar to that used in the socket module, where several constants share
a description.
 1998-02-13 21:55:21 +00:00
Fred Drake fc931ecf92 In description of sound_similar(), break up the markup for long 
\code{} at each embedded space, so that the words will wrap.  This keeps
it from being too ugly.
 1998-02-13 21:49:12 +00:00
Fred Drake 315b5d8a7f In description of __import__, second paragraph, break up the markup for long 
\code{} at each embedded space, so that the words will wrap.  This keeps it
from running off the side of the page, and is only slightly weird.
 1998-02-13 21:26:35 +00:00
Fred Drake 83bd081920 Minor stuff: 
Explain what happens when a negative shift count is used (what exception).

Mark the title "Python Reference Manual" as \emph{}, for consistency.

"info" --> "information"

Tell more about the data attributes of file objects, using the {datadesc}
environment.

When refering the user to the language reference for information about
internal types, tell what internal types to expect information on.
 1998-02-13 20:59:25 +00:00
Fred Drake fb74a463ad Add "Pretty Good Privacy" as well as "PGP" to the index. 1998-02-13 14:52:17 +00:00
Fred Drake c9c456ef69 In add_label_data() description, use "\samp{}" instead of "``\code{...}''" 
to indicate the interpreted letters from the format string.
 1998-02-13 14:48:00 +00:00
Fred Drake 7f6e2c45ec Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments 
in the running text.

For computed attribute and method names (where there's a \var{} part to
the name), use the non-indexing forms of \datadesc{} and \funcdesc{}.
This doesn't change the printed output, but removes 3 rejections from the
makeindex run and allows the LaTeX2HTML support to exclude these from the
index.
 1998-02-13 14:38:23 +00:00
Fred Drake b441eb84d3 Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments 
in the running text.

For computed method names (where there's a \var{} part to the name), use
the non-indexing form of \funcdesc{}.  This doesn't change the printed
output, but removes 3 rejections from the makeindex run and allows the
LaTeX2HTML support to exclude these from the index.
 1998-02-13 14:37:12 +00:00
Fred Drake 2a4646c660 Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous 
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
 1998-02-13 06:58:54 +00:00
Guido van Rossum da62398139 Correct description of BUILD_SLICE. 1998-02-12 03:53:02 +00:00
Fred Drake dd1f6cc402 Mark opcode arguments \var{} in the running text. 
In IMPORT_NAME description:  "is not affect:" --> "is not affected:"
 1998-02-12 03:32:18 +00:00
Fred Drake 71c1ef34bf Remove second index entry for UserList. 1998-02-12 03:10:55 +00:00
Guido van Rossum 692b87db15 Added \nodename; added index entry for UserList. 1998-02-11 23:00:08 +00:00
Guido van Rossum f6a7b443c2 Added entries for stat, commands modules. 1998-02-11 22:58:55 +00:00
Guido van Rossum 6d659b3e51 Added entries for re, soundex modules. 1998-02-11 22:57:10 +00:00
Guido van Rossum 38e0df330b Some subtleties suggested by Tamito Kajiyama, including an added 
\nodename macro for a section with a very underscriptive title.
 1998-02-11 22:55:55 +00:00
Guido van Rossum f5370f4019 Turn the space in [\^ ...] into a hard space: [\^\ ...]. 1998-02-11 22:52:47 +00:00
Guido van Rossum 1c974db134 Split UserDict and UserList on two separate lines; added entries for 
modules symbol and token.
 1998-02-11 22:36:17 +00:00
Guido van Rossum ee833cca7b Don't break a long line at an unpleasant point. 1998-02-11 22:34:51 +00:00
Guido van Rossum 8b0927eddc Added missing entry for cmath. 1998-02-11 22:33:57 +00:00
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 526467ce0a Removed all references to the \rfcindex{} macro; now only \rfc{} is used. 1998-02-10 21:42:27 +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
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 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
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 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 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 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 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 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 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 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
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 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 4d4f9e726a Removed \mytableofcontents; just use \tableofcontents. 1998-01-13 22:25:02 +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 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 dca8792b52 Added openright option the the \documentclass{} for each of the manuals. 1998-01-13 16:53:23 +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
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 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 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 0b1337d674 Add module index before the general index. 1998-01-02 02:59:09 +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 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 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
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
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 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 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 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 1b6cf78c15 Reduce warning count from partparse.py. 1997-12-29 20:28:33 +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 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 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 1656d17c42 Changed all \verb\...\ markup to either \code{...} or \samp{...}. 1997-12-29 16:55:50 +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 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
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 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 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 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
Guido van Rossum e4eb2231fd AMK's latest 1997-12-17 00:23:39 +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 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 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
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 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
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
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