Commit Graph

1538 Commits

Author SHA1 Message Date
Fred Drake 4f6d6e487c Fix things. Blame Andy Eskilsson <andy.eskilsson@telelogic.se>.
But I'm not giving this or the info files out until Andy (or anyone else)
agrees to take over the maintenance of this script!  Hah!
1998-04-17 15:28:09 +00:00
Fred Drake 4f5155817b Mark TMPDIR correctly. 1998-04-17 14:51:04 +00:00
Fred Drake bdbdb80b0b Separate the Mac-related files from the library reference files. The new
variable isn't used yet.
1998-04-17 14:01:44 +00:00
Fred Drake 1d9fb63293 Remove commented-out Mac chapter. 1998-04-17 13:24:55 +00:00
Fred Drake 12f842e33e Adjust to allow both general and module indexes.
PDF output properly supports the outline.
1998-04-17 02:52:12 +00:00
Fred Drake 60961c561d Python HOWTO document that replaces the old Mac section from the reference
manual.
1998-04-17 02:47:13 +00:00
Fred Drake b51429a145 Adjust so that it works as part of a HOWTO-based manual. 1998-04-17 02:46:34 +00:00
Fred Drake d579ed8239 Shift (re-)definition of \theindex to the document classes so that it doesn't
break HOWTO documents.
1998-04-17 02:45:41 +00:00
Fred Drake 300775d222 Hide \varvars from "public" interface. 1998-04-17 02:17:00 +00:00
Fred Drake 08932054e9 New helper functions to help deal with parameter parsing.
Use the helpers in do_cmd_*() and do_env_*(); *much* cleaner!
1998-04-17 02:15:42 +00:00
Fred Drake 64bdc24301 Code cleanup, some syntax modernization. 1998-04-17 02:14:12 +00:00
Fred Drake 6b303b4bdd Signature for dir() omitted the optional argument. 1998-04-16 22:10:27 +00:00
Fred Drake bf88c3830e Fix the broken PDF links, really this time!
Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:22 +00:00
Fred Drake a2c2a836d7 Fix the broken PDF links, really this time!
"." cannot be part of the target names either.

Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:01 +00:00
Fred Drake a88d681255 Change the form of the name given to each page of the PDF from "page.%d" to
"page.%dx"; this works around an acroread bug that causes targets not to be
recognized if their name is a prefix of another target in the file.
1998-04-15 14:53:28 +00:00
Fred Drake d671e8fb87 Added dependency on the tools/toc2bkm.py script for the PDF files. 1998-04-15 14:50:56 +00:00
Guido van Rossum 3c4378bd9b Some patches by Drew Csillag; plus a few of my own uncommitted changes. 1998-04-14 20:21:10 +00:00
Fred Drake 12d9fc94f4 Use shorter labels; using long labels creates problems on the Macintosh.
(Thanks, Just!)
1998-04-14 17:19:54 +00:00
Fred Drake 95638f5b0f Added entry for Tkdnd.py. 1998-04-14 04:55:43 +00:00
Fred Drake e3ae5198a3 Update to use the new release number. Will generalize in the next round. 1998-04-13 21:55:56 +00:00
Fred Drake f5013f1f0c Add RELEASE make variable; this gets the entire release # ("1.5.1"). 1998-04-13 21:02:49 +00:00
Fred Drake 68fede768a Added item in Misc. for getpass module. 1998-04-13 20:31:31 +00:00
Fred Drake 4d2996d473 Fix version number. 1998-04-13 20:29:45 +00:00
Fred Drake 916d8f8733 No more threats, just list the new methods under "AST Objects". 1998-04-13 18:46:16 +00:00
Fred Drake c4f1ca1967 Add a note that pickling is supported. 1998-04-13 16:27:27 +00:00
Fred Drake 3e7a48e0d9 Revert markup around list of display fields from the disassembler; it doesn't
look at good in print, but doesn't break the HTML.
1998-04-13 16:15:02 +00:00
Fred Drake 3ad125e611 Fix bug in little-used markup: don't forget to pass the source text along! 1998-04-13 14:18:57 +00:00
Fred Drake 7238988657 Fixed example to load the startup file from a script (didn't test for the
file's existance).

Removed some XXX comments about extension modules which support pickling.

Added text from AMK about the readline and rlcompleter modules.

Thanks, AMK!
1998-04-13 01:31:10 +00:00
Fred Drake 003d8da779 Typo: (and often severly limited) -- severely
Typo: (but not to the tuple or list into which the item it put!) -- is put

Thanks, AMK!
1998-04-13 00:53:42 +00:00
Fred Drake b85fbec83b "ZeroDevisionError" --> "ZeroDivisionError"
Thanks, AMK!
1998-04-13 00:50:04 +00:00
Fred Drake a608febd5f Fix typo. (What I get for trying to fix bugs at home and running conversions
at work....)
1998-04-12 03:58:13 +00:00
Fred Drake ae9bc67e0e Don't append () to the name of an object attribute in the index. 1998-04-12 03:49:46 +00:00
Fred Drake 6250205166 Use {methoddesc} instead of {funcdesc} for object methods. 1998-04-12 03:31:31 +00:00
Fred Drake 898601bf8f Add cPickle to the list of modules in the chapter. 1998-04-12 03:08:41 +00:00
Fred Drake d6d88ffaf9 Add cStringIO to the list of modules in the chapter. 1998-04-12 03:07:35 +00:00
Fred Drake c303e67f3c The built-in exceptions are not still strings, so make no claims about them. 1998-04-12 02:48:47 +00:00
Fred Drake c94d9348ca In descriptions of Py_GetPrefix() and Py_GetExecPrefix(), make sure the
"--" at the start of the configure options isn't collapsed to "-" when the
HTML is generated.
1998-04-12 02:39:13 +00:00
Fred Drake 1072e46263 Added a simpler, working {verbatim} support that generates legitimate HTML.
(2 lines, explained by 6 lines of comments....)
1998-04-12 02:16:34 +00:00
Fred Drake b73bc31e39 Removed partially broken {verbatim} support. 1998-04-12 02:13:14 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 17e564042d Change order of \seemodule macros at end of pickle module section. 1998-04-11 20:43:51 +00:00
Fred Drake 9463de2092 Document cPickle and cStringIO. 1998-04-11 20:05:43 +00:00
Fred Drake fab2f34538 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 18:46:56 +00:00
Fred Drake 7e9383ab59 Add a comment to indicate the methods of the StringIO are being discussed... 1998-04-11 18:05:24 +00:00
Fred Drake 70c460c84d Remove imaplib from the undocumented list. 1998-04-11 16:58:26 +00:00
Fred Drake a38a2867d0 Include () after function name.
One more logical mark.
1998-04-11 16:57:05 +00:00
Fred Drake 0d213d3497 When the text of a table cell should be wrapped, used a "p" column. 1998-04-11 16:40:46 +00:00
Fred Drake 2b8c95e4ed Minor housing cleaning in HTML that gets generated. 1998-04-11 16:26:02 +00:00
Fred Drake 34672dbb38 Remove over-active replace-string turds. 1998-04-11 16:24:21 +00:00
Fred Drake 8f6b958fdb Use {memberdesc} to mark the instance attributes. 1998-04-11 15:11:55 +00:00
Fred Drake 7dba8e2ab4 Hmmm... better add some \label macros for logical addressing while I'm at it. 1998-04-11 13:51:05 +00:00
Fred Drake 2a37455967 It's "Lauder", not "Lauders"! 1998-04-11 13:48:26 +00:00
Fred Drake 9d4b6c52c3 Update the module index support to use the changed field separator for the
input file to buildindex.py.
1998-04-11 05:21:14 +00:00
Fred Drake e5cf53ad89 Formatting nits.
An index entry.
1998-04-11 05:02:45 +00:00
Fred Drake eb4ed15be8 Shift index entries around a little so the HTML doesn't have weird spacing. 1998-04-11 04:52:15 +00:00
Fred Drake 1e0f8bfea9 Add imaplib to appropriate lists. 1998-04-11 04:27:07 +00:00
Fred Drake 36751b0ed2 Remove obsolete module soundex from list of modules. 1998-04-11 04:23:07 +00:00
Fred Drake c48b772a77 Remove obsolete module rand from list of modules.
Add fileinput to list.
1998-04-11 04:22:02 +00:00
Fred Drake 89de314cfc First cut at documentation for imaplib. Based on original documentation by
Piers Lauders.
1998-04-11 04:19:04 +00:00
Fred Drake 756a9e87b1 do_env_memberdesc(): Fix argument parsing for {memberdesc} environments.
(The bug was detected by the Q/A team -- me!  Please, help review the docs!)
1998-04-11 03:12:06 +00:00
Fred Drake 007bac3b0b Added smtplib.py (thanks, Guido!). 1998-04-09 18:54:01 +00:00
Fred Drake 2cb824cbf9 Don't use \samp when \code is better.
Consistently use ' instead of ":  this conforms to my unofficial stance that
constants should be presented using the repr() whenever it makes sense.  This
isn't because I think repr() is the greatest thing since spam, just that it's
an easy to adopt consistency standard.  (It also holds no new surprises!)
1998-04-09 18:10:35 +00:00
Fred Drake 5cca42e0b7 do_cmd_lineii(),
do_cmd_lineiii():  Fix markup style conversion to HTML tags for first column.
	(The endtag wasn't formed properly.)
1998-04-09 17:59:11 +00:00
Fred Drake 6b529ae0c0 Remove @webchecker.pickle in the "clean" target. 1998-04-09 15:46:36 +00:00
Fred Drake 45c634ecae Work around a small (& annoying) limitation of the latex2html support for
\seemodule.  This is far easier than figuring out the real problem, but it
works.
1998-04-09 15:44:58 +00:00
Fred Drake 8a254b5967 Removed misleading comment about GNU software. This module and the zlib
library have no relationship with GNU software other than implementing some of
the same algorithms and file format.  (The zlib module is more general.)
1998-04-09 15:41:44 +00:00
Fred Drake 45084ed52a Added note about current status of info generation. 1998-04-09 15:19:41 +00:00
Andrew M. Kuchling 253328104f Many markup changes (to \regexp, mostly)
Clarified text on 8-bit cleanness, complemented sets like [^5], and {m,n}
  qualifier.
1998-04-09 14:56:04 +00:00
Fred Drake 02a8e6b600 Update release number and date. 1998-04-09 14:50:47 +00:00
Fred Drake 20ca9171c1 Don't assume that \version expands to the 3-character major.minor number; it
is the full release version name ("1.5.1beta1", for instance).

Add section for previously documented obsolete modules.  Includes ni, rand,
and soundex.
1998-04-09 14:32:28 +00:00
Fred Drake 363ab1a613 Comment out the soundex section. 1998-04-09 14:23:48 +00:00
Fred Drake 2de75ec245 Don't assume that \version expands to the 3-character major.minor number; it
is the full release version name ("1.5.1beta1", for instance).
1998-04-09 14:12:11 +00:00
Fred Drake 9da38814a3 Use the correct URL to AMK's regex-to-re HOWTO! 1998-04-09 14:06:33 +00:00
Fred Drake 54c3947fbc Updated URL to AMK's regex-to-re HOWTO. 1998-04-09 14:03:00 +00:00
Fred Drake 5406e7071f Added reference to AMK's HOWTO on the topic. 1998-04-09 14:02:02 +00:00
Fred Drake 223395c0a0 Added imaplib. 1998-04-09 13:55:06 +00:00
Fred Drake b8efda01e6 Update URL to the related HOWTO document. 1998-04-09 13:49:18 +00:00
Fred Drake bd400881dd Add section for ni back in, but comment it out. 1998-04-09 11:04:19 +00:00
Fred Drake eac469ca3d Commented out sections on obsolete & Macintosh modules. 1998-04-09 04:51:07 +00:00
Fred Drake f1b72ddf82 Reduced description of the obsolete method Stats.ignore(). 1998-04-09 04:49:56 +00:00
Fred Drake 058068d992 Nearly a complete re-write.
Basically, it now works and produces a nice-looking HTML index.

Shows some promise for extensibility, but still young.  Needs useful comments.
1998-04-08 23:12:51 +00:00
Fred Drake 166abbabf9 Remove option to strip out <tt>...</tt> from index entry text; this is now
left to the buildindex.py script.

Change the field separator used in the index.dat file so utilities like grep
are useful on these files; they can't typically handle NUL bytes.

Protect index entries for environment variables from being handled as
case-insensitive by buildindex.py.
1998-04-08 23:10:54 +00:00
Guido van Rossum ae2be7144d Correct definition of CTIME. 1998-04-08 22:44:25 +00:00
Fred Drake 3f3c25fc03 Set flag to remove <tt>...</tt> markup from the index entries; it just ends up
looking really bad in popular browsers, mostly due to vertical size differences
between the roman and monospaced fonts.
1998-04-08 13:46:24 +00:00
Fred Drake 2764dd33cf Separate sections on anydbm and dumbdbm.
This is the last separation; each module now gets its own section.  This will
be useful in performing conversions.
1998-04-07 22:08:02 +00:00
Fred Drake 8e729ec31a Caught a few more spurious \setindexsubitem macros.... 1998-04-07 22:06:41 +00:00
Fred Drake 5ab5503b8a Use {classdesc} and {memberdesc} where appropriate. 1998-04-07 22:01:33 +00:00
Fred Drake a3f5c32f18 Removed unnecessary \setindexsubitem. 1998-04-07 21:45:52 +00:00
Fred Drake 1ce3604cfd Separate UserDict and UserList documentation into separate sections. 1998-04-07 20:05:33 +00:00
Fred Drake df0e3fcb63 Markup nit. 1998-04-07 20:04:27 +00:00
Fred Drake c708605f4f Added a reference to the discussion in Knuth's "Sorting and Searching", and
noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
1998-04-07 19:58:19 +00:00
Fred Drake 41565f66b6 Data attributes of objects should not be indexed with trailing parentheses! 1998-04-07 19:32:40 +00:00
Fred Drake 396b827a93 Minor markup nit. 1998-04-07 19:17:27 +00:00
Fred Drake 82d493fb96 Fixed some index entries. 1998-04-07 19:14:17 +00:00
Fred Drake 6b9ff7257b Added entry for wdb. 1998-04-07 19:09:32 +00:00
Fred Drake 810349b685 Fix the formatting of the list of fields in the disassemble() function. 1998-04-07 14:16:41 +00:00
Fred Drake 272fb3aaa4 Added poplib.
Made the module lists look like the other module lists in the documentation.
1998-04-07 14:15:28 +00:00
Fred Drake af370ea254 Move a short paragraph outside the description of ASTType. 1998-04-05 20:23:02 +00:00
Fred Drake 3a0351cf85 Remove all uses of \sectcode; we can now use logical markup everywhere. 1998-04-04 07:23:21 +00:00
Fred Drake e7957184d2 Change \sectcode to logical markup. 1998-04-04 07:17:47 +00:00
Fred Drake fc57619811 Remove obsolete \setindexsubitem macros.
Massive migration to methoddesc and memberdesc.

Logical markup as needed.

A sprinkling of index entries for flavor.
1998-04-04 07:15:02 +00:00
Fred Drake 71c1e502f0 Moved some things around.
Adjusted a couple of the comments to be more informative.

Tell a little bit about what obsolete means now, and how to use obsolete
modules.
1998-04-04 07:03:19 +00:00
Fred Drake 13beac1289 Removed obsolete \setindexsubitem macros. 1998-04-04 06:46:51 +00:00
Fred Drake 85ea68b2a2 Added index entries. 1998-04-04 06:46:05 +00:00
Fred Drake 81acc2e988 Remove obsolete \setindexsubitem macro.
Logical markup, methoddesc, etc.
1998-04-04 06:35:41 +00:00
Fred Drake 61f45c7cb5 Remove obsolete \setindexsubitem macro,
Added index entries.

Markup nits.
1998-04-04 06:31:51 +00:00
Fred Drake b208f128b4 Added index entry. 1998-04-04 06:28:54 +00:00
Fred Drake 82143348aa Remove obsolete \setindexsubitem macro. 1998-04-04 06:28:14 +00:00
Fred Drake 858f787a02 Fix index entry for HTMLParser class. 1998-04-04 06:25:27 +00:00
Fred Drake 41788db3e2 Logical markup.
Index entries.
1998-04-04 06:23:02 +00:00
Fred Drake 9b28fe285d Logical markup. 1998-04-04 06:20:28 +00:00
Fred Drake e14dde2117 Fixed description of similarity between m[name] and m.getheader(name),
reported by Samuel L. Bayer.

Use methoddesc instead of funcdesc, etc.
1998-04-04 06:19:30 +00:00
Fred Drake d275de985a Remove obsolete lines like this:
\setindexsubitem{(in module frobnitz)}

These are no longer needed when present before any other \setindexsubitem{}
in the module section.  The indexsubitem is now set by \bimodindex and
\stmodindex.
1998-04-04 05:56:51 +00:00
Fred Drake 4bde97f190 Add fileinput section under Misc. Services. 1998-04-04 05:50:12 +00:00
Fred Drake ea2f2b9409 Use new index style for makeindex.
Add dependency on libfileinput.tex for lib.dvi.
1998-04-04 04:21:45 +00:00
Fred Drake 35ca0d69e1 Document fileinput. 1998-04-04 04:20:51 +00:00
Fred Drake a8e262b0b2 Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
Fred Drake 10ad52e8af Minor cleanliness. 1998-04-04 04:19:20 +00:00
Fred Drake 0a2eb138e7 Style specification for building *.ind from *.idx. This is needed to avoid
wrapping of long lines, which tools/indfix.py doesn't understand, and needs
to to handle collapsing of entries which can share a common emtry and just
be short entries themselves.  We get the added benefit of nicer formatting.
1998-04-04 04:18:06 +00:00
Fred Drake 07bcd99873 Start at updating the template a little bit. There's a lot of stuff that's
just not here yet.
1998-04-03 21:25:16 +00:00
Fred Drake 47cfd03dff Increase space between the end of a regexp and the little right floor symbol
used as a closing quote.  At AMK's request.
1998-04-03 21:22:31 +00:00
Fred Drake fe03e81aa5 Removed line of obsolete markup. 1998-04-03 20:35:03 +00:00
Guido van Rossum 791468f731 Some clarifications of out-of-range group indexes/names 1998-04-03 20:07:37 +00:00
Fred Drake 61885924b1 Lots of markup consistency nits.
Logical markup.
1998-04-03 07:16:46 +00:00
Fred Drake 6251c169c6 Small nits.
One more index entry.

Be more specific about an exception raised by range().
1998-04-03 07:15:54 +00:00
Fred Drake 8efde2197b Several minor markup nits. 1998-04-03 07:13:56 +00:00
Fred Drake 9f6aec870e "alternative" is a noun, use "alternate" for the adjective.
Minor nits.
1998-04-03 07:12:52 +00:00
Fred Drake 14c198b146 Talk about some minor nits... 1998-04-03 07:11:32 +00:00
Fred Drake 395e8e4860 Capitalize "Python" for consistency.
Describe UserDict and UserList individually so they aren't too hideous in
the presentation.
1998-04-03 07:10:41 +00:00
Fred Drake 7932a6bf8c Small markup nits. 1998-04-03 07:09:38 +00:00
Fred Drake d59db4f974 Small consistency nits. 1998-04-03 07:06:56 +00:00
Fred Drake 2123774287 Capitalize "Python" for consistency. 1998-04-03 07:06:01 +00:00
Fred Drake e6cedb362c New index entries. 1998-04-03 07:05:16 +00:00
Fred Drake 3f1c4720b5 Use {methoddesc} as appropriate. 1998-04-03 07:04:45 +00:00
Fred Drake 5dabeed4ea Index entries.
Consistency nits.
1998-04-03 07:02:35 +00:00
Fred Drake d0a40cb4cf Added comment crediting Sue Williams with this documentation section (the
ACKS file should be checked....).
1998-04-03 06:56:31 +00:00
Fred Drake 55e3cbd115 Fix one typo.
Add a manpage reference.

Add an index entry.
1998-04-03 06:54:27 +00:00
Fred Drake 74810d5abb Nits.
Add {excdesc} for zlib.error.

Use {methoddesc} where appropriate.
1998-04-03 06:49:26 +00:00
Fred Drake c3486318e0 Add index entry for GzipFile class. 1998-04-03 06:48:16 +00:00
Fred Drake d678cb7a6c Logical markup. 1998-04-03 06:35:54 +00:00
Fred Drake 9fee071ab6 Markup consistency. 1998-04-03 06:21:23 +00:00
Fred Drake 5bfe4850cf Consistency: Don't use module name when referring to functions defined
in the same module.
1998-04-03 06:14:54 +00:00
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 16a19c46a9 Mention the --help option to tools/mkhowto.sh. 1998-04-03 05:41:38 +00:00
Fred Drake 5bd7fccef9 Minor nits.
Index entry.
1998-04-03 05:31:45 +00:00
Fred Drake a594bafde7 Normalized case rules in section headings.
Moved stuff from "Recent Additions to 1.1" to "More on Defining Functions".
This means there's now a short section on "Defining Functions" immediately
followed by a long section "More on Defining Functions."
1998-04-03 05:16:31 +00:00
Fred Drake 7e9d3148d1 Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00