Commit Graph

706 Commits

Author SHA1 Message Date
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