Commit Graph

2636 Commits

Author SHA1 Message Date
Fred Drake d158b85896 This doesn't need to do nearly as much for the new conversion, so
simplify.
1999-08-02 14:32:46 +00:00
Fred Drake 031e222499 A few small improvements to the conversion. 1999-08-02 14:32:11 +00:00
Fred Drake c71b802c47 Markup nits.
Adjust examples to use the object interface instead of the function
interface.
1999-08-02 14:30:52 +00:00
Fred Drake ce201128b0 Fixed hyperlink references to the __builtin__ and __main__ modules;
error reported by Dale Nagata <DNagata@creo.com>.
1999-08-02 14:13:09 +00:00
Fred Drake eac8abee4e Ripped out the old conversion. 1999-07-29 22:42:27 +00:00
Fred Drake 865e9ff98e Added a few more passes through the document fragment. Not actually
very interesting.
1999-07-29 22:23:19 +00:00
Fred Drake 96e4a06fa6 Massive changes.
Separate the Conversion class into a base and a subclass; the subclass
is pretty minimal but the separation is useful for....

NewConversion:  New class that implements a somewhat different
		approach to the conversion.  This uses a table of
		instances (rather than tuples) that have more
		information than the tuples used for the older
		conversion procedure.  This allows a lot more control
		over the conversion, and it seems to be pretty
		stable.

TableEntry,
Parameter:	New classes that are used to build the conversion
		specification used by NewConversion.

TableParser:	xmllib.XMLParser subclass that builds a conversion
		specification from an XML document.

load_table():	Convenience function that loads a table from a file.

main():  Added flags --new and --old; these select which conversion is
	 used.  The default is --new.

Several fixes have been made in the old conversion as well; these were
done before writing & switching to the new conversion, and should be
archived.

The next checkin of this file will discard the old conversion; is is
kept in this checkin to allow it to be retrieved if needed, and to
avoid lossing the bugfixes that have been made to it in the interim.
1999-07-29 22:22:13 +00:00
Fred Drake 2394c98c05 Minor updates. 1999-07-29 22:14:09 +00:00
Fred Drake ada2de67b3 Use the (new) buildFragment() method of the EsisBuilder rather than
implementing it all here.
1999-07-29 22:13:31 +00:00
Fred Drake f032cdbb24 Some minor cleanup. 1999-07-29 22:03:52 +00:00
Fred Drake bc2285eb60 Conversion specification, used by a new path through latex2esis.py.
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
1999-07-29 22:03:11 +00:00
Fred Drake 478a265057 Minor update. 1999-07-29 22:01:39 +00:00
Fred Drake c35367e439 Change an {\em ...} to \var{...} and a {\bf ...} to \program{...} (the
new markup makes sense in context).

These allow the SGML/XML conversion updates to work, & should not have
still been in there anyway.
1999-07-29 13:56:41 +00:00
Fred Drake 4ef3ea0cc4 Add support for bzip2 compression.
New target: distfiles, create all distribution archives, regardless of
archive format.  (Individual targets remain for each archive format.)
1999-07-27 16:30:59 +00:00
Fred Drake 5772f33b6c Add support for bzip2 using --bzip2. 1999-07-27 16:29:30 +00:00
Fred Drake b5213c3010 Ignore additional compressed formats. 1999-07-27 14:23:25 +00:00
Fred Drake 8d21243c3e Added description of optional parameter to UserDict constructor.
Omission reported by Barry Warsaw.
1999-07-26 15:45:52 +00:00
Fred Drake 7dcc69a979 Add zip archive support for html, pdf, ps, and latex archives.
"zips" target produces all possible .zip files.
1999-07-23 16:11:36 +00:00
Fred Drake 8ea15f3495 Add --zip parameter; make this able to produce .zip files as well as
.tgz files.
1999-07-23 16:09:11 +00:00
Fred Drake de5d5ce7bc Update getattr() description to document the optional third
parameter.  Thanks to Barry Warsaw for pointing out the oversight.
1999-07-22 19:21:45 +00:00
Fred Drake 06c5a8b52e Make the default target xml instead of sgml. 1999-07-22 13:57:12 +00:00
Fred Drake 7dbde51f97 Make the default target xml instead of sgml.
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
1999-07-22 13:56:51 +00:00
Fred Drake 5d48e458e4 typo: privide --> provide
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
1999-07-20 13:21:42 +00:00
Fred Drake 860e256147 Added comment clarifying that RELEASE is the documentation release
number, not the Python release.

Removed VERSION since it is not used.
1999-07-12 16:52:50 +00:00
Fred Drake 6b3fb78ca8 do_cmd_funclineni(): New function; non-indexing form of \funcline. 1999-07-12 16:50:09 +00:00
Fred Drake 6db897c52c Move chdir() and getcwd() descriptions to "Files and Directories" with
a pointer from the "Process Parameters" section.  Based on comments
from Aahz Maruch, Tim Peters, and GvR.
1999-07-12 16:49:30 +00:00
Fred Drake f930d827bb Use the same names for CLASS attributes as elsewhere. 1999-07-12 16:28:50 +00:00
Fred Drake bb7eff96d4 Updated Milan's email address. 1999-07-12 15:26:43 +00:00
Fred Drake 3a4ceb707d Several methods return tuples, not lists. 1999-07-07 14:04:38 +00:00
Fred Drake 363d67c2e6 Move some misc. comments from the example section to the main section.
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion).  Add a blank line
after the import line for clarity.
1999-07-07 13:42:56 +00:00
Fred Drake 1508970a47 dir() method description revised based on comments from Greg Stein. 1999-07-07 13:36:22 +00:00
Fred Drake 6166b871a2 Missing space; reported by Robert Kern <kernr@ncifcrf.gov>. 1999-07-06 21:00:18 +00:00
Fred Drake d5dfe984e7 Fix a number of minor problems pointed out by /F. 1999-07-06 15:50:23 +00:00
Fred Drake 0d6e6e0b39 Fixed typo reported by /F; thanks! 1999-07-06 15:43:55 +00:00
Fred Drake e72d48d5b2 Bump the release number to 1.5.2p1. 1999-07-06 14:30:04 +00:00
Fred Drake 919e74ce88 Darn! Forgot to re-target. 1999-07-02 15:27:14 +00:00
Fred Drake 5a8aaa7542 Remove one item.
Rearrange & comment on others.
1999-07-02 14:31:41 +00:00
Fred Drake 82ac24ffb0 Minor markup nit. 1999-07-02 14:29:14 +00:00
Fred Drake 0452007dcc Added entry for asyncore module. 1999-07-02 14:27:03 +00:00
Fred Drake 41796918af Fix a few markup nits, improve some index entries. 1999-07-02 14:25:37 +00:00
Fred Drake 7d80779532 New documentation from Chris Petrilli <petrilli@amber.org>. 1999-07-02 14:25:03 +00:00
Fred Drake 227020894a For spawn*(), point to the magic constants; some readers have a hard
time finding the bindings.
1999-07-02 14:01:03 +00:00
Fred Drake e4694eba0f Removed entries for several modules which have been documented.
Updated comments on several remaining modules.
1999-07-01 20:42:57 +00:00
Fred Drake 4c8d83f311 Documentation for dl module from Moshe. 1999-07-01 20:40:21 +00:00
Fred Drake 44a7a7c5d0 Added entry for dl module. 1999-07-01 20:39:59 +00:00
Fred Drake 85b5683307 Remove extraneous "contains" -- pointed out by Daniel Barclay
<danielb@digitalfocus.com>.

Added credit to Martin von Loewis for creating the module and
documentation.
1999-07-01 16:31:03 +00:00
Fred Drake 859dc53a52 Per Frank Stajano's suggestion, state explicitly that the functions
described in the sub-sections are directly available at the module
level.  He found this confusing.
1999-07-01 13:54:40 +00:00
Fred Drake b216060627 Make the reference to the os module in the module synopsis (for the
table at the front of the chapter) a hyperlink.
1999-07-01 13:53:32 +00:00
Fred Drake f1ad207f2a Made several grammatical corrections based on comments from Daniel
Barcla <danielb@digitalfocus.com>.

Also added example of what happens when a parameter is set both
positionally and by a keyword (one of Daniels suggestions related to
that paragraph).
1999-06-30 15:32:50 +00:00
Fred Drake 3d0971e33e For "Matching vs. Searching", remove comment that the section is
incomplete; I don't remember what else I thought I was going to put
in, but it looks o.k. to me know.
1999-06-29 21:21:19 +00:00
Fred Drake 9b59a303a8 Added some reminders. 1999-06-29 18:54:03 +00:00
Fred Drake d85b5a418a Move the setting for secnumdepth to the document classes; make the numbering
for the manual class go one deeper than it previously did (\subsection
entries will now be numbered); no change for howto documents.

This makes it easier to refer precisely to smaller sections using \ref.
1999-06-29 18:15:59 +00:00
Fred Drake 6bf37debb9 Added some minor prose before the descriptions of the data attributes
to make it clear that these are instance attributes, not module data.
1999-06-29 18:13:37 +00:00
Fred Drake abc64b74c8 Added entry for pty module. 1999-06-29 18:12:22 +00:00
Fred Drake a4b5d58790 pty documentation from Moshe; with small edits. 1999-06-29 18:11:22 +00:00
Fred Drake 31d10cbe26 Improve description of the example. 1999-06-29 17:08:41 +00:00
Fred Drake f5213c2a3d Usage nit: a bunch of "nor"s should have been a single "or".
Make reference to the copy_reg module a hyperlink.
1999-06-29 16:02:12 +00:00
Fred Drake 8ad2703bfb Minor wording change in section title. 1999-06-29 16:00:22 +00:00
Fred Drake ac00c4c1c6 byteswap() method: Tell *what* exception gets raised when the type
cannot be byteswapped.
1999-06-29 15:58:00 +00:00
Fred Drake 9118f7cfc4 Remove unnecessary comma. 1999-06-29 15:53:52 +00:00
Fred Drake 9e0b6229f6 Comment out XXX comment; this needn't appear in the formatted
versions.  XXX comments only need to be grep-able.
1999-06-29 15:45:09 +00:00
Fred Drake ef1a029d4c Add note about not being able to use this module with modules not
implemented in Python.
1999-06-29 15:43:02 +00:00
Fred Drake 4886c66daf Moshe: Remove extraneous "and". 1999-06-29 14:57:12 +00:00
Fred Drake e4d78189e8 Added entries for mutex and nis modules. 1999-06-27 15:02:37 +00:00
Fred Drake 7fefba5c13 NIS documentation from Moshe. 1999-06-27 15:01:08 +00:00
Fred Drake 2231357aa6 Mutex documentation from Moshe. 1999-06-27 15:00:41 +00:00
Fred Drake 7a65a26f81 Separate documentation of SUNAUDIODEV from sunaudiodev; this mirrors
similar constructs elsewhere (al/AL, gl/GL/DEVICE).
1999-06-27 14:53:11 +00:00
Fred Drake 14ae4b48fb Fix some typos.
Add an index entry.
1999-06-25 19:13:36 +00:00
Fred Drake c4e3bf9b5e Add entries for the sched module. 1999-06-25 18:54:30 +00:00
Fred Drake 7e990323b4 Moshe's section on the sched module, with edits. 1999-06-25 18:52:44 +00:00
Fred Drake 60b66e1f7b Update to Sjoerd's documentation of the chunk module, with some
additions from Moshe's version.  Used my table for describing the
chunk format, and added some markup and index entries.
1999-06-25 17:52:17 +00:00
Guido van Rossum cf6905f986 Clarify the example by explicitly importing the fcntl module -- this
avoid being fooled into thinking that fcntl and FCNTL are the same
thing -- they aren't!  (fcntl is the extension, FCNTL.py is h2py
output that defines all the constants).

(XXX The example is still weird -- I think there's a more portable way
to do locking now.  That's for someone else to fix...)
1999-06-24 17:58:44 +00:00
Fred Drake 7c2426439e Removed tty module entry. 1999-06-23 17:31:59 +00:00
Fred Drake 1b2dc9045e Add entries for tty module. 1999-06-23 17:29:02 +00:00
Fred Drake 0bccd73be0 Updates from Moshe, again edited by me. Describe the parameters to
border() using a table instead of text for ease of comprehension.
1999-06-23 17:28:01 +00:00
Fred Drake 92f3f41424 Added "See Also" section for termios module. 1999-06-23 15:12:09 +00:00
Fred Drake ae4d5c23f5 Various updates. 1999-06-23 14:56:13 +00:00
Fred Drake 66239d5530 tty module documentation from Moshe, with some editing and an added
"See also" section.
1999-06-23 14:30:19 +00:00
Fred Drake af81a509c3 Added more sections... 1999-06-23 13:34:22 +00:00
Fred Drake b742a42bc0 Two more from Moshe! 1999-06-23 13:33:40 +00:00
Fred Drake 707f8e67b9 Added entry for the chunk module. 1999-06-22 18:50:06 +00:00
Fred Drake 97793ab6b9 New section from Moshe Zadka, modified by FLD for markup, some
additional content.
1999-06-22 18:49:20 +00:00
Fred Drake 0f871dc39e Added some "See also" references to htmllib docs.
Documented htmlentitydefs.
1999-06-21 21:20:56 +00:00
Fred Drake 2cd31dc3ea Added entry for curses module. 1999-06-21 21:14:30 +00:00
Fred Drake 4997f4d54a Added entries for four of Moshe's documentation sections. 1999-06-21 21:13:50 +00:00
Fred Drake a4070cef5e Preliminary documentation for the curses module by Moshe Zadka, with
lots of markup fixes and some English nits fixed.

Still needs real review.  Some of the function signatures used in this
module are really bad!  (Two leading optional parameters? Ugh!)
1999-06-21 21:13:09 +00:00
Fred Drake d5d55ea02e Fix a markup error. 1999-06-21 18:36:09 +00:00
Fred Drake 4755e7d5c1 Three more modules documented by Moshe! 1999-06-21 18:25:49 +00:00
Fred Drake 6f49e0a154 Added a few minor comments, mostly to discourage documentation of
really old modules that may become obsolete.
1999-06-18 19:58:59 +00:00
Fred Drake a48a083edb Added paragraph about potential re-initialization of extension
modules; responding to suggestion by Robin Boerdijk
<Robin.Boerdijk@nl.origin-it.com>.
1999-06-18 19:17:28 +00:00
Fred Drake a88ef00a50 Further clarfication of the system-dependence of the system() return
value, based on comments from Tim Peters.
1999-06-18 19:11:25 +00:00
Fred Drake 46e1a32edf Re-categorize the dump module as obsolete. 1999-06-18 17:12:15 +00:00
Fred Drake 354e98222c fpformat has been documented for at least a week now! 1999-06-18 15:21:25 +00:00
Fred Drake 26921da2c9 Small markup & usage adjustments. 1999-06-17 18:58:02 +00:00
Fred Drake 924b42de9c When looking for things that might be modules, include *module.c from
the Modules/ directory.  Most of the remaining undocumented modules
seem to be living there.
1999-06-17 18:49:18 +00:00
Fred Drake e019789962 Correction: the parameters of new.instance() are type-checked.
Edited several of the descriptions for English usage and more
consistent style.
1999-06-17 18:15:07 +00:00
Fred Drake de69ae1753 Updated version from Moshe, with a re-written warning about the
side-effect of cmpcache.cmp() using statcache.stat() internally.
1999-06-17 17:40:52 +00:00
Fred Drake 173ba5e3bc Minor markup nits. 1999-06-17 17:09:23 +00:00
Fred Drake 97c2fa03e5 Small English usage nits. 1999-06-17 16:38:18 +00:00
Fred Drake 7487c02209 Small markup and English usage nits. 1999-06-17 16:10:39 +00:00