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

797 Commits

Author SHA1 Message Date
Fred Drake 2cfc835b7b Minor nits. 
Lots of index entries.
 1998-04-03 06:12:21 +00:00
Fred Drake 4e6688747c Consistency nits: 
Use math-mode pi instead of mixing forms.

Use spaces around relational operators.
 1998-04-03 06:04:12 +00:00
Fred Drake 76547c5631 Minor nits. 
Moved IGNORECASE & friends to "top level" definitions following compile(),
since there is no other case of nesting in the manual.

Use {memberdesc} and {methoddesc} as appropriate.
 1998-04-03 05:59:05 +00:00
Fred Drake dff21a6b93 Minor nits. 
Indent code sample to use 4-space indents.
 1998-04-03 05:42:10 +00:00
Fred Drake 5bd7fccef9 Minor nits. 
Index entry.
 1998-04-03 05:31:45 +00:00
Fred Drake 6a79be8db8 Capitalize "Python" for consistency. 
Add an index entry.
 1998-04-03 03:47:03 +00:00
Fred Drake 930f134fc9 Logical markup. 1998-04-03 03:44:56 +00:00
Fred Drake dd1f52b0c4 Use {seealso} environment to refer to the struct module. 
Document ArrayType.

Use {memberdesc} and {methoddesc} environments, as appropriate.

Minor nits.
 1998-04-03 03:35:24 +00:00
Fred Drake 3a18f3ba38 Hyphenate "built-in" for consistency. 1998-04-02 19:36:25 +00:00
Fred Drake dc40904a32 Hyphenate "built-in" for consistency. 1998-04-02 18:54:54 +00:00
Fred Drake da70ee1fae Use methoddesc and memberdesc, as needed. 
Added description of BastionClass, since it is referred to in the Bastion
description as subclassable.
 1998-04-02 18:51:30 +00:00
Fred Drake 182bd2d176 Use methoddesc instead of funcdesc to describe the only method. 1998-04-02 18:50:21 +00:00
Fred Drake 0a73d4db51 Removed reference to ni module. 1998-04-02 18:46:44 +00:00
Fred Drake 9ac80cb5bd Removed references to ni. 1998-04-02 18:45:09 +00:00
Fred Drake b401637bd8 Markup nits, index entries. 1998-04-02 18:44:38 +00:00
Fred Drake 674e0fd7a8 Be more specific about where in RFC 1421 to look, since it's not at all 
obvious when taking a quick look.

Say "base64" instead of "base-64", since that seems to be how it's referred
to in other RFCs.
 1998-04-02 16:24:29 +00:00
Fred Drake 9e9c89e67c Some nits. 
Fixed quoting in third paragraph of the findmatch() description.
 1998-04-02 15:53:07 +00:00
Guido van Rossum e9625e86b8 AMK's version from the latest pypcre distribution. This clarifies a 
few things and adds docs for what happens to escapes in replacement
strings.
 1998-04-02 01:32:24 +00:00
Fred Drake 8fe533e6a0 Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
Fred Drake f76abb51ef Make sure both hyphens of a long-option show up in the HTML output. 1998-03-27 00:37:40 +00:00
Guido van Rossum 685ef4e604 According to Tim Peters, there should be 'print' statements in one 
particular example.
 1998-03-17 14:37:48 +00:00
Fred Drake cce1090d49 Change "\," to just "," in function signatures. This is easier to maintain, 
works better with LaTeX2HTML, and allows some simplification of the python.sty
macros.
 1998-03-17 06:33:25 +00:00
Fred Drake f3aa0e0627 Revert the index stuff to work better with LaTeX2HTML. 1998-03-17 06:23:13 +00:00
Fred Drake d98329cdf0 Logical markup. 
Convert a {description} list to a {tableii} environment.
 1998-03-16 06:38:42 +00:00
Fred Drake 1a855fad30 Markup nits. 
Adjusted some index entries.
 1998-03-16 05:23:50 +00:00
Fred Drake abdea226dc Adjusted an index entry. 1998-03-16 05:22:08 +00:00
Fred Drake 52405c899a Added an index entry. 1998-03-16 05:21:08 +00:00
Fred Drake 7bf5e0828f Use {classdesc} consistently. 1998-03-16 05:07:04 +00:00
Fred Drake c9808b3af2 Logical markup. 
Emphasized title "4Sight User's Guide".
 1998-03-15 02:04:59 +00:00
Fred Drake 5f874d618f Markup nits. 
Some additional index entries.
 1998-03-15 01:59:57 +00:00
Fred Drake bd9ded8190 Logical markup. 
Replace ugly {description} with a {tableii}, for the what() return values.
 1998-03-14 20:09:15 +00:00
Fred Drake 434493b207 Logical markup. 
Replace ugly {description} with a {tableii}, for the option descriptions.
 1998-03-14 19:47:23 +00:00
Fred Drake a891230688 Logical markup, using {classdesc} as appropriate. 1998-03-14 07:08:02 +00:00
Fred Drake f9e1f658ed Logical markup. 1998-03-14 07:00:41 +00:00
Fred Drake 2e495c93b0 Logical markup, using {classdesc} as appropriate. 1998-03-14 06:48:33 +00:00
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