Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
14,353 Commits 7 Branches 587 Tags 2.5 GiB
Commit Graph

3105 Commits

Author SHA1 Message Date
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
Fred Drake 873f0297c3 Add reminder that wave.open() documentation should be updated for the 
next Python release.
 1999-06-17 15:20:44 +00:00
Fred Drake 551d2b14e7 Add entries due to additional sections from Moshe. 1999-06-17 15:12:50 +00:00
Fred Drake 26da2840ac Add/remove entries due to additional sections from Moshe. 1999-06-17 15:12:16 +00:00
Fred Drake 64bc94e3ec New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>! 1999-06-17 15:11:35 +00:00
Fred Drake e55702b024 Added note to __not__() description that this operation is defined 
only by the interpreter core and is not overridable by objects.

Based on comment from David Ascher on the list.
 1999-06-15 20:56:40 +00:00
Fred Drake 1e4402998f Several new index entries to make find this easier. 
Noted that name=value is allowed in addition to name: value.
 1999-06-15 17:30:59 +00:00
Fred Drake 42120eaca5 Added entries for new sections from Moshe. 1999-06-14 19:52:10 +00:00
Fred Drake c46864e982 Misc. changes related to the new sections. 1999-06-14 19:49:50 +00:00
Fred Drake 21572fdcb6 New sections from Moshe Zadka <moshez@math.huji.ac.il>. 
These document CGIHTTPServer, SimpleHTTPServer, and linecache.
 1999-06-14 19:47:47 +00:00
Fred Drake 7df4dd7de2 Add entry for the fpformat module. 1999-06-11 18:36:42 +00:00
Fred Drake 1739d2f9ee Documentation for the fpformat module by Moshe Zadka 
<mzadka@geocities.com>.
 1999-06-11 18:31:00 +00:00
Fred Drake 2f9790195b Added 'ce' to the list of "registered" values for os.name. 
Make references to the posix module hyperlinks.
 1999-06-11 18:28:37 +00:00
Fred Drake 5eb992beed Last night's scribbles: 
- Revise abstract based on Guido's comments from way back.
- Point out that LaTeX is a structured system & we're using it that
  way.
- Add a small section on marking up code examples.
 1999-06-11 14:25:45 +00:00
Fred Drake 9c5cc14d23 Some clarifications on operations for mapping types, based on comments 
from Gerry Weiner <gerry@ucar.edu>.
 1999-06-10 22:37:34 +00:00
Fred Drake 697c779d98 Adjust indexing for __import__(); based on comments by Stefan Franke 
<sfranke@cdc-group.com>.
 1999-06-10 22:09:20 +00:00
Fred Drake 28b1770521 Improve index entry for "import"; responding to comments by Stefan 
Franke <sfranke@cdc-group.com>.
 1999-06-10 22:08:16 +00:00
Fred Drake 06a73f042a Work around latex2html problem; reported by Gerrit Holl 
<gerrit.holl@pobox.com>.
 1999-06-10 21:23:31 +00:00
Fred Drake 4d5c87ba11 Declare the "util" module obsolete. 1999-06-10 21:17:11 +00:00
Fred Drake f64f8a0877 Fixed typo reported by Bennett Benson 
<BennettBenson@mn.mediaone.net>.
 1999-06-10 15:30:21 +00:00
Fred Drake 7a62128722 At David Ascher's request, clarify that os.system() always returns 0 
on Win95 & Win98.
 1999-06-10 15:07:05 +00:00
Fred Drake ae0f292576 Fix typo reported by Robert Kern <kernr@ncifcrf.gov>. 1999-06-10 15:03:07 +00:00
Guido van Rossum 66ab4e8af2 Patch by Jim Fulton to document the new parse_qls(). 1999-06-10 03:11:41 +00:00
Guido van Rossum 4727456d46 Add doc for timegm(). 1999-06-09 15:11:58 +00:00
Fred Drake 5fac2ab220 Fix availability clause; mention availability of similar functionality 
for Windows using win32pipe.
 1999-06-01 17:55:52 +00:00
Fred Drake f1882422d2 Oops, forgot to remove the individual module indexes for lib & mac now 
that there's a Global Module Index; there can be only one!
 1999-05-27 21:56:11 +00:00
Fred Drake 3c27ec2c05 Add <hr> after top navigation bar; now looks more like the rest of the 
navigation bars in the HTML output.
 1999-05-27 21:52:51 +00:00
Fred Drake d2a727feee Hack: make sure LaTeX2HTML doesn't change -- to - in mkhowto 
description.
 1999-05-27 21:45:54 +00:00
Fred Drake 3aa70d63b9 Document the "pid" attribute of the Popen3 class. 
Use memberdesc instead of datadesc to document object attributes.
This gets the index right.
 1999-05-27 17:50:59 +00:00
Fred Drake a7ce52b03a Typo reported by Gerry Wiener <wiener@rap.ucar.edu>: 
items -> item

The returned list will then have one more items than the number of
non-overlapping occurrences of the separator in the string.
 1999-05-27 17:18:08 +00:00
Fred Drake abc8cc63ce Move some \index entries around so we can avoid using empty comments; 
empty comments trigger a bug in LaTeX2HTML.

Problem reported by Gerry Wiener <gerry@ucar.edu>.
 1999-05-26 16:15:17 +00:00
Fred Drake 82f355a36a Change the example of configuring for large file support under Solaris 
to use `getconf LFS_CFLAGS`.  Steve Clift (the author of the section
and large file support) agrees that this is the right thing to do.
 1999-05-26 13:03:34 +00:00
Fred Drake 6b330ba857 "proces" --> "process"; reported by Gerry Wiener <gerry@ucar.edu>. 
Added some index entries.
 1999-05-25 13:42:26 +00:00
Fred Drake 0eb7b2a659 Enhanced docstring and some comments. 
_begin_macro_rx:  Fixed RE that didn't properly allow a space after
		  the name of the macro.  This affects the conversion
		  of the tutorial.
 1999-05-19 17:37:37 +00:00
Fred Drake c4811d8208 Modify to perform "---" to "&mdash;" conversion outside of 
verbatim-like environments.  The list of verbatim-like environments is
a defined by a variable in main().
 1999-05-18 17:34:51 +00:00
Fred Drake c41e1e5f5e Remove the "---" to "&mdash;" conversion; this is wrong in verbatim 
environments.  Move the conversion to esis2sgml.py.
 1999-05-18 17:33:01 +00:00
Fred Drake 338da93734 SET_LINE_NO ==> SET_LINENO 
Reported by Corran Webster <cwebster@math.tamu.edu>.
 1999-05-17 20:57:07 +00:00
Fred Drake 33378da964 Added paragraph explaininng the text/binary flavors of some methods, 
to make it easier for people to find what they're looking for.
 1999-05-17 16:35:15 +00:00
Fred Drake d1fb77970d Document \e, \url. 
Add a few more comments about mkhowto.

Based on comments from Albert <hat@se-46.wpa.wtb.tue.nl>.
 1999-05-17 16:33:54 +00:00
Fred Drake 4f52867d95 Don't \input boilerplate.tex, fill in the real stuff. 3rd party 
documents probably aren't written by Guido.  ;-)
 1999-05-17 16:02:38 +00:00
Fred Drake 87f768e20b Attempted to clarify usage of the \declaremodule macro somewhat; 
Michael Hudson's documentation for bytecodehacks exhibits incorrect
usage.

Added some comments about how to set up the mkhowto script for use
with documents not contained in the documentation source tree.
 1999-05-17 15:22:45 +00:00
Fred Drake 3e4c614c16 define_module(): Check the module type for validity before using. 
This reflects the changes made in
		  ../texinputs/python.sty.
 1999-05-17 15:00:32 +00:00
Fred Drake 66823029a4 \declaremodule: Typo. 1999-05-17 14:57:26 +00:00
Fred Drake 5bc8d99bce \declaremodule: Make this more robust. Only attempt to add an index 
entry based on the module type if the type is known.
		 Otherwise, spit out a warning the the module type
		 parameter was bad and generate a "plain" index entry.

		 Without this, the bad module type was emitted as
		 text.

Problem noticed by processing Michael Hudson's docs for
bytecodehacks.
 1999-05-17 14:47:10 +00:00
Fred Drake 8ee593cb46 The conversion temporary files should not be ignored here anymore, 
since they shouldn't be here.  Only ignore the output tarballs in this
directory.
 1999-05-13 18:57:28 +00:00
Fred Drake dbc2d08ff5 POP3.uidl(): Update description based on comments from Piers Lauder 
<piers@cs.su.oz.au>.
 1999-05-13 18:48:14 +00:00
Fred Drake dab44682c2 PyCObject_FromVoidPtr(): Clarify that the destr function will only be 
called on destruction is non-NULL.
 1999-05-13 18:41:14 +00:00
Fred Drake 431f0ce547 Small nits around some of the index entries. 
When refering to chapters, use \ref, don't hardcode the chapter
number.
 1999-05-13 18:38:11 +00:00
Fred Drake ab03215204 make_index_entry(): Remove. Not only did this override the 
l2hinit.perl version of the function (which
		     overrode a version in latex2html), but
		     do_cmd_index() was overridden.  Since
		     do_cmd_index() was the only caller, we can trash
		     this.

define_indexing_macro():  New function used during setup to support
			  more dynamic dispatch for indexing.

process_index_macros():  New function; implement dynamic dispatching
			 of indexing support functions, allowing many
			 targets used in indexing to be shared by
			 multiple index entries.  I.e., something like
			 \index{foo}\bifuncindex{bar} can now share a
			 single target anchor.

These indexing changes reduce the amount of clutter in the generated
HTML files.  In the reference manual, this cuts the number of targets
by 44%.  Targets are less affected when generated by environments
rather than macros.
 1999-05-13 18:36:54 +00:00
Fred Drake 76febdf3fd make_index_entry(): Remove. This is overridden in python.perl and 
was never called in this incarnation.  The
		     other version is simpler as well.
 1999-05-13 16:41:19 +00:00
Fred Drake 7088df4c56 Removed old comments. 1999-05-13 16:20:30 +00:00
Fred Drake 84bd6f3b18 Change the look of \seemodule output to fit in better. 1999-05-11 15:42:51 +00:00
Fred Drake 03c05a5192 Move the "See also:" section so it appears are part of the top HTML 
page of the section.
 1999-05-11 15:15:54 +00:00
Fred Drake 184e8360e8 Added module references; minor grammatical fixes. 
All suggested by Eric Raymond.
 1999-05-11 15:14:15 +00:00
Fred Drake 9ade7e0110 Added missing comma, reported by Eric Raymond. 1999-05-11 13:45:37 +00:00
Fred Drake e779d4f03b Lots of adjustments to deal with the document content now being stored 
in a fragment rather than the main document object.
 1999-05-10 19:36:52 +00:00
Fred Drake 54fb7fb9d0 Some more fixes. 
Add controls for some of the esoteric indexing macros.
 1999-05-10 19:36:03 +00:00
Fred Drake b894370f6a Fixed some index entries. 
In the __coerce__ description, None should be returned if the
conversion is *impossible*, not *possible*.  Reported by Robert Kern
<kernr@ncifcrf.gov>.
 1999-05-10 13:43:22 +00:00
Fred Drake 2697694e4a ExtendedEsisBuilder.push(): Override inherited definition. We don't 
want to push nodes into the document, but into a document
	fragment, since we're not necesarily working with something
	that's well-formed.
 1999-05-07 21:14:28 +00:00
Fred Drake f79acbdaa1 Fix some bugs introduced in the previous checkin. 1999-05-07 21:12:21 +00:00
Fred Drake 96c00b0b5e Define & use a Conversion object. It's still really ugly, but at 
least there's a token object in here now!  ;-)
 1999-05-07 19:59:02 +00:00
Fred Drake b0bc7f2d6c Updated connect_ex() documentation based on comments in the newgroup 
(M.-A. Lemburg and GvR).
 1999-05-06 22:03:50 +00:00
Fred Drake a871c2e747 Make it work for "manual" documents as well as "howto" documents. 
This still doesn't understand anything about multiple source files or
checking time dependencies.
 1999-05-06 19:37:38 +00:00
Fred Drake 1ea7c75687 Reflect recent patch for float % and divmod() by Tim Peters. Content 
updates by Tim Peters, markup by FLD.
 1999-05-06 14:46:35 +00:00
Fred Drake 4437fdf265 Make sure latex2html doesn't produce a hard link between foo/foo.html 
and foo/index.html.  Make a copy instead.  (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
 1999-05-03 14:29:07 +00:00
Fred Drake d2d1eef025 Make sure latex2html doesn't produce a hard link from $part/$part.html 
and $part/index.html.  Make a copy instead.  (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
 1999-05-03 14:27:45 +00:00
Fred Drake ab005d5f6c Revert constraint on the GIF wildcard; we missed a few! 1999-04-30 15:58:45 +00:00
Fred Drake 8961bd1529 Added top navigation bar for consistency and color. There's not a lot 
there, but the "modules" icon is active.
 1999-04-29 19:54:08 +00:00
Fred Drake a00754468f make_nav_panel(): Remove the spurious NAME="tex2html\d+" attributes 
added to the anchors in the navigation bars.  These
		   are added somewhere deep with l2h, and are stupid.
 1999-04-29 19:06:56 +00:00
Fred Drake 50c507e4b4 Added wcnew target to run the "wcnew" version of webchecker. 1999-04-29 19:04:55 +00:00
Fred Drake 673c65e500 Use the new module-key for the FL module when hyperlinking (the old 
one caused problems on case-insensitive file systems).
 1999-04-29 18:42:18 +00:00
Fred Drake dbf7d99ae7 For the tutorial, use numeric node names and split by chapter. 1999-04-29 18:29:38 +00:00
Fred Drake c1db512b2b Nasty hack to add a --numeric parameter to skip the use of "logical" 
names.
 1999-04-29 18:28:48 +00:00
Fred Drake 664c72f8a1 Move index.html rules to the end since it wedges font-lock. 
Remember to delete index.html for clobber since it is now generated..
 1999-04-29 17:04:21 +00:00
Fred Drake d09120b5b9 Added index entries for operator precedence; suggestion from Randall 
Hopper <rhh@vislab.epa.gov>.
 1999-04-29 16:43:42 +00:00
Fred Drake 62e80138f4 Make sure the global module index is added to the HTML tarball. 1999-04-29 15:44:49 +00:00
Fred Drake 5cc0a9b252 Generate index.html from index.html.in. This avoids having to modify the 
index to update the version number; boilerplate.tex remains the only document
source for this information.
 1999-04-29 15:42:19 +00:00
Fred Drake fe1e207841 Constrain a wildcard a little more. 1999-04-29 15:32:27 +00:00
Fred Drake d03e9e34de Don't point readers to rand, point to random! And make it a hyperlink 
while you're at it.

Also, when discussing order of reading, make it clear that chapter 2
is assumed background material for the remainder of the manual.
That's needed for terminology if nothing else!
 1999-04-29 13:41:17 +00:00
Fred Drake bdadf0f7f3 Explain comments at the start of chapter 3. This is needed since they 
appear in the examples without any further explanation, and the
tutorial doesn't have this information explicit anywhere else.
Omission reported by Jon Black <jblack@Ridgeway-Sys.com>.
 1999-04-29 13:20:25 +00:00
Fred Drake 0e1de8bd6b Minor nits, partly in response to comments from Jonathan Black 
<jblack@Ridgeway-Sys.com>.
 1999-04-29 12:57:32 +00:00
Fred Drake 9ef8635c8c Annotate a couple of entries further. 1999-04-29 04:23:37 +00:00
Fred Drake 0041a94e74 Fill in a few holes in the "Very High Level" chapter. 1999-04-29 04:20:46 +00:00
Fred Drake 5f342ac2a7 Always use "section" when referring to sections of a document, not "Section". 1999-04-29 02:47:40 +00:00
Fred Drake a4a90ddeac Clarify that the Modules/ directory is in an unpacked source 
distribution; this is not clear for Windows users.
 1999-04-29 02:44:50 +00:00
Fred Drake c0fcbc1ac6 Update starship URLs. 1999-04-29 02:30:04 +00:00
Fred Drake c7c9a64833 Remove the \date macro; just pick it up from boilerplate.tex. 1999-04-28 18:24:02 +00:00
Fred Drake ea0020571f Use \rfc to mark some remaining RFC references. 
Remove comment about full name bug in getaddrlist(); this has been
fixed for a while now.

Work around LaTeX2HTML space-dropping bug.

Mention that the fp attribute can be used to read the message body.
 1999-04-28 18:11:09 +00:00
Fred Drake ea07f2751a setup_column_alignments(): Adding valign=baseline to the <td> tag 
makes the alignment work on Navigator as
			    well as IE.  Uglier HTML, but it looks
			    right.
 1999-04-28 17:11:21 +00:00
Fred Drake 250ba78565 Let's try again: new assertion. 1999-04-28 16:57:01 +00:00
Fred Drake 610172b0de Removed (empty) description of \optional from the "Inline Markup" 
section; that's not really the right place for it.
 1999-04-28 16:54:00 +00:00
Fred Drake 2f4bebd28c Fill in a few holes. 1999-04-28 16:43:11 +00:00
Fred Drake ac3dc83eb6 Fix up the HTML generated for envdesc and macrodesc environments. 
Make it possible for the user to tell the difference.  ;-)
 1999-04-28 16:42:29 +00:00
Fred Drake d02573d13b Handle \p and \op in parameter lists for the environment and macro 
description environments.
 1999-04-28 16:33:04 +00:00
Fred Drake 4050e00e41 Adjust the message that gets added to the bottom of each page about 
where to send comments.
 1999-04-28 15:06:08 +00:00
Fred Drake 0a0fd595b3 \filenq: Like \file, but don't use single-quotes; this looks better 
in tables.
 1999-04-28 14:59:44 +00:00
Fred Drake f74e5b7936 Control the layout of output tables a little better so they're easier 
to debug.  Small code cleanup around tables.
 1999-04-28 14:58:49 +00:00
Fred Drake cf282cdafb Point to the library reference manual for os.path documentation (in 
macpath section).
 1999-04-28 14:04:36 +00:00
Fred Drake 79189b5fd5 do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This 
fixes a rendering problem on IE5.

General adjustments to the table* environments, including using
<thead> and <tbody>.  Attempt to adjust the vertical alignment of the
table cells so that the baseline of the first cell matches the
baseline of the remaining cells:  When the first cell is small and the
second cell of the same row is multi-line, the first cell was
vertically centered by default.  Specifying valign=baseline fixes the
problem on IE, but Netscape seems to ignore both valign=top and
valign=baseline (even though valign is NS's fault!).  Make the
horizontal alignment of 'p' columns left instead of center (for the
headings).
 1999-04-28 13:54:30 +00:00
Fred Drake 505c49199a Added "See also" reference to PyOpenGL. 1999-04-27 18:05:06 +00:00
Fred Drake dcf17f3860 mhlib is now documented. 1999-04-23 22:24:12 +00:00
Fred Drake a4966647ec Markup consistency. 1999-04-23 22:22:27 +00:00
Fred Drake 1c7cd63a2b Nits. 1999-04-23 22:03:00 +00:00
Fred Drake 957ac3fadb Add section for the sha module. 1999-04-23 21:52:18 +00:00
Fred Drake 154fc6dcf7 Patch from Greg Ward adding descriptions of S_IMODE() and S_IFMT(), 
and an explanation of why any of stat.S_*() would be used instead of
os.path.is*().  (With some really small enhancements by me.)
 1999-04-23 20:54:57 +00:00
Fred Drake 24aca83dbd Fixed typo and font-control problem reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:33:59 +00:00
Fred Drake 29cf682b71 Clarifications on the first(), next(), and previous() functions, based 
on comments from Detlef Lannert <lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:32:59 +00:00
Fred Drake 861192120b Fix a grammatical error reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:07:02 +00:00
Fred Drake ec8b905bd4 Fix a couple of typos reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:01:17 +00:00
Fred Drake 16214fb017 Fix a couple of grammatical errors reported by Detlef Lannert 
<lannert@lannert.rz.uni-duesseldorf.de>.
 1999-04-23 20:00:53 +00:00
Fred Drake 4aa4f30759 Work-around LaTeX2HTML space-dropping bug. 1999-04-23 17:30:40 +00:00
Fred Drake 87b8f318b0 Fixed some logical markup nits. 
Added a pointer to Grail in the see-also section, since it's used as
an example.
 1999-04-23 17:26:24 +00:00
Fred Drake deb7e096d3 Logical markup. 1999-04-23 17:11:53 +00:00
Fred Drake 806764bee4 No, __repr__() does not accept a parameter other than self. 1999-04-23 17:03:21 +00:00
Fred Drake 0fbec55e23 Shorten the section title. 
Adjust markup to be a little more consistent with the rest of the
document.
 1999-04-23 16:44:53 +00:00
Fred Drake eea97ea063 Shorten the section title. 1999-04-23 16:07:38 +00:00
Fred Drake 86bd5e48c3 Shorten the section title. 
Fix a couple of grammatical errors.
 1999-04-23 16:02:30 +00:00
Fred Drake 7475e04fad Work around a space-dropping problem in LaTeX2HTML. 
Clarify the usage of a parameter.
 1999-04-23 15:57:23 +00:00
Fred Drake ae35aa8b63 Added "See also" sections linking to binascii. 1999-04-23 15:52:18 +00:00
Fred Drake ee4d54ea33 Refer to the binhex module, not the non-existent hexbin module. 
Added a "See also" section.
 1999-04-23 15:42:36 +00:00
Fred Drake 26f7cfe9c7 Fix some glaring markup consistency problems (presentation was 
broken).

Added a "See also" section.
 1999-04-23 15:41:53 +00:00
Fred Drake 10682c28b4 Added a couple more requests from users. 1999-04-23 15:15:58 +00:00
Fred Drake 812860e81d Hack places where '--' should appear as literal output but the -- was 
(properly) converted to - by LaTeX2HTML.
 1999-04-23 14:46:18 +00:00
Fred Drake d960dc81b5 Fix square brackets around optional parameters to macros. 1999-04-23 14:44:53 +00:00
Fred Drake 7a737dffc4 General small improvements and fixes. 1999-04-23 14:41:44 +00:00
Fred Drake ffbe68723a Make internal module references hyperlinks wherever it makes sense. 1999-04-22 21:23:22 +00:00
Fred Drake 7b8b125fa6 Remove bogus characters in code sample. 1999-04-22 21:19:53 +00:00
Fred Drake fcf94d4edd Work around LaTeX2HTML comment-handling bug. 1999-04-22 20:55:59 +00:00
Fred Drake 4a406c619b Shorten the section title. 1999-04-22 20:52:44 +00:00
Fred Drake c4a623ebdc Add command line flags to just list the files that contain the 
offending lines or to include line numbers in the output.
 1999-04-22 20:32:21 +00:00
Fred Drake c8c40ff699 Added a "See also" section with some external references. 1999-04-22 20:16:02 +00:00
Fred Drake 4e28c593ad Markup nits. 
Make module references hyperlinks.
 1999-04-22 18:25:47 +00:00
Fred Drake b7168c3a07 Clean up lots of mark up. 1999-04-22 17:53:37 +00:00
Fred Drake 79936fe73f Added descriptions of the various exceptions, based on the docstrings. 
Various small cleanups.
 1999-04-22 17:23:34 +00:00
Fred Drake c8993aad10 Logical markup and small nits. 
Don't refer to the STDWIN chapter; chances are really good it wasn't
included.  ;-)
 1999-04-22 16:50:40 +00:00
Fred Drake 12a956921f Make some module references hyperlinks. 1999-04-22 16:47:27 +00:00
Fred Drake b774550ba5 Minor logical markup nits. 
Make some module references hyperlinks.
 1999-04-22 16:46:18 +00:00
Fred Drake dd6c6d9b0a Clean up some mark up. 1999-04-22 16:45:26 +00:00
Fred Drake e2effbd32d Fix minor (English) usage nits. 1999-04-22 16:21:09 +00:00
Fred Drake bcd5454d63 Reference to urllib module can be a hyperlink. 1999-04-22 16:17:45 +00:00
Fred Drake 4429772ea3 Fix dropped space in the HTML output. 1999-04-22 16:15:34 +00:00
Fred Drake babdda53d5 Make reference to the socket module a hyperlink. 1999-04-22 16:03:30 +00:00
Fred Drake bf0f4346af Shorten the section title. 1999-04-22 15:53:35 +00:00
Fred Drake 47894d2858 Don't describe this module as being a popen() wrapper; that's a little 
confusing.  This is clearly Unix-specific; label it as such.
 1999-04-22 15:19:01 +00:00
Fred Drake a694e00085 Remove \platform declaration; this module is generic. 1999-04-22 15:14:11 +00:00
Fred Drake 5254a6d682 Move stat to the Generic chapter. 1999-04-22 15:01:44 +00:00
Fred Drake ca69a03dd6 Don't refer to the system documentation as "man pages"; too 
Unix-centric.  Note that this can be used with the output of
os.fstat() as well as os.stat() and os.lstat().
 1999-04-22 14:55:43 +00:00
Fred Drake 7bf96ca32d Make an assertion. 1999-04-22 14:16:59 +00:00
Fred Drake 6532b9b8e0 Updated a comment and the release number. 1999-04-22 14:16:14 +00:00
Fred Drake 2ea30f4d8c Add warning that last() and previous() don't work for hashtable 
databases (opened using hashopen()), as noted by Skip Montanaro on
comp.lang.python.
 1999-04-22 14:06:36 +00:00
Fred Drake 693a2c6581 Script to locate uses of \module where the module referred to is not 
the module being documented at that point in the documentation; these
are candidates for conversion to \refmodule, which produces a
hyperlink in the HTML and PDF versions of the output.
 1999-04-22 13:08:09 +00:00
Fred Drake e0208cc83c Add a couple of items. 1999-04-22 13:05:52 +00:00
Fred Drake adade928be Fill in a lot of the blanks. Add a start to the LaTeX primer section. 
Use Python-traditional XXX comments instead of square brackets that
aren't as obvious or usefully grepable.
 1999-04-22 13:05:27 +00:00
Fred Drake 30a535c0f7 Added support for adding environment/macro parameters more cleanly: 
\op adds an optional parameter, and \p adds a required parameter.
These are only defined in the context of the parameter list parameter
of the envdesc and macrodesc environments.
 1999-04-22 13:03:49 +00:00
Fred Drake b9f1f6d90b Misc. markup nits. 
All sections get reasonable file names in the HTML output.
 1999-04-21 21:43:17 +00:00
Fred Drake 2dabd811cd Fix markup typo. 1999-04-21 21:33:24 +00:00
Fred Drake d146edfaf1 Mark the "Notes:" sections under tables the same way it's done 
elsewhere in the library reference.
 1999-04-21 21:15:35 +00:00
Fred Drake b11d108cdc The version information here was checked good in 1999, not 199. ;-) 
Added "See also" reference to zlib home page, even though it's
mentioned in the text.
 1999-04-21 18:44:41 +00:00
Fred Drake 2799f9d09a Reflow paragraph to work around LaTeX2HTML dropping a space. 
Make all references to the os module hyperlinks.
 1999-04-21 18:33:47 +00:00
Fred Drake 6d20caa2ce Reflow paragraph to work around LaTeX2HTML dropping a space. 1999-04-21 18:17:11 +00:00
Fred Drake 543e19d923 Small nits, more hyperlinks. 
Added more information for cStringIO.
 1999-04-21 18:15:22 +00:00
Fred Drake 048b75bd9a Make references to whrandom hyperlinks. 1999-04-21 18:14:22 +00:00
Fred Drake ec6baaf618 Small markup nits. 1999-04-21 18:13:31 +00:00
Fred Drake 54f2fdd1ad Make the names of the referenced modules hyperlinks; they had not been 
marked at all.
 1999-04-21 18:10:08 +00:00
Fred Drake 02e8c0fd2d Nits. Reference to signal module becomes a hyperlink. 1999-04-21 18:01:14 +00:00
Fred Drake 283c588402 Work around LaTeX2HTML comment-handling bug. 1999-04-21 17:57:15 +00:00
Fred Drake 318c0b131f Logical markup nits. 
Make references to other modules hyperlinks.
 1999-04-21 17:29:14 +00:00
Fred Drake c3845a14d3 Logical markup & other small nits. 1999-04-21 17:18:04 +00:00
Fred Drake 11bc8cfee3 Explain *why* the copytree() implementation is presented as the 
example!
 1999-04-21 17:08:51 +00:00
Fred Drake e688aec707 Textual references to the glob module can be hyperlinks. 1999-04-21 17:04:43 +00:00
Fred Drake 737aa552f4 Markup nit to fixed dropped space in HTML output. 1999-04-21 17:01:15 +00:00
Fred Drake 4747f7f61d Markup nits. 1999-04-21 16:41:40 +00:00
Fred Drake 4f6e4fbc1d Added "See also" reference to xdrlib. 
Markup nits.
 1999-04-21 16:38:53 +00:00
Fred Drake 69fa56327a Markup nits. 1999-04-21 16:29:57 +00:00
Fred Drake 8307e21a2a Mark the references to module names use \module or \refmodule (the 
closing paragraph used \code).
 1999-04-21 16:29:18 +00:00
Guido van Rossum 6ed122a334 Important fix mentioned by The Dragon De Monsyne: the sendmail() 
method does _not_ disconnect the connection when it throws a
SMTPHeloError!
 1999-04-21 16:19:16 +00:00
Fred Drake a889add5d6 Oops; minor nit in example: none of the other interactive examples 
show the "trailing" prompt, so don't show it here!
 1999-04-21 16:00:24 +00:00
Fred Drake ca675e491b do_cmd_funcline(): Remove some bogus generated stuff from the output 
(some text was only intended for the index).
 1999-04-21 15:58:58 +00:00
Fred Drake 3d815bd1c7 Added link to xdrlib module in "See also" section. 1999-04-21 15:57:29 +00:00
Fred Drake 085b8121eb Fix some remaining index & consistency nits. (Many data member 
references were being omitted from the general index.)
 1999-04-21 14:00:29 +00:00
Fred Drake c3fcd6fa0e Added index entry for "file objects"; this is appearantly referenced 
somewhere in the Reference Manual, and someone tried to locate it via
the index.  Report on the omission by Stefan Franke
<sfranke@cdc-group.com>.
 1999-04-21 13:58:17 +00:00
Fred Drake 7ceb5777d7 Added doc for the "module" attribute on the class descriptor objects; 
omission repoorted by Glyn Webster <glyn@ninz.org.nz>.
 1999-04-20 18:18:53 +00:00
Fred Drake ad56dafd62 Added example use of pack_list() to help explain the pack_item 
parameter.  Lack of clarity reported by Matthew Gallagher
<hew@hons.cs.usyd.edu.au>.
 1999-04-20 13:41:14 +00:00
Fred Drake 4ae52694c9 Updated to reflect additions. 1999-04-19 21:21:28 +00:00
Fred Drake 32c562bdec colorsys docs from David Ascher. 1999-04-19 21:20:13 +00:00
Fred Drake 9d15881744 bsddb docs from Skip Montanaro; added interesting links. 1999-04-19 21:19:21 +00:00
Fred Drake e9af64c373 Remove superfluous index entry for posix.popen(); no longer 
appropriate since popen() is only documented in os.
 1999-04-16 19:00:48 +00:00
Fred Drake dac9a4e3db Added link to Fredrik Lundh's online Tkinter reference material. 1999-04-16 18:26:22 +00:00
Fred Drake 31bfbc6bff Minor nits, include author info. 1999-04-16 14:03:32 +00:00
Fred Drake 511281ac00 In list of sequence comparison examples, "=" should be "==". Reported 
by Mirko Liss <n89553@hrz.uni-paderborn.de>.
 1999-04-16 13:17:04 +00:00
Fred Drake 0ebd5483be Removed dbhash from the undocumented list. 1999-04-15 16:05:29 +00:00
Fred Drake 460f1dd6b7 Add libdbhash.tex. 1999-04-15 15:12:37 +00:00
Fred Drake 666255f5ac Document the dbhash module, and link to it from appropriate places. 1999-04-15 15:11:40 +00:00
Fred Drake f4cbada3f9 Correct documentation for <file>.read(); Python makes a serious 
best-effort to return 'size' bytes.  Point out that this may mean
multiple fread() calls.  Reported by Anders Hammarquist
<iko@iko.pp.se> via the Debian crew.
 1999-04-14 14:31:53 +00:00
Fred Drake e79f5c1d2b Use the standard stylesheet here as well. 1999-04-14 14:28:48 +00:00
Fred Drake 6ab98325f7 Use the tools/mkdvi.sh script to generate DVI and PDF output for the 
library reference now that it's sufficiently capable.
 1999-04-14 14:04:39 +00:00
Fred Drake c260c0bcdb Further refinement, to allow this to handle the library reference as 
well as the other "manual" documents.
 1999-04-14 13:13:32 +00:00
Fred Drake 011f6fca31 Typo: "Otherwose" --> "Otherwise" (reported by Joakim Sernbrant 
<joakim.sernbrant@front.se>).

Misc. small fixes to the logical markup.
 1999-04-14 12:52:14 +00:00
Fred Drake 79d41ccdd3 Add some support for the module index, so this can be used to build 
the .aux file for any of the "manual" class documents.
 1999-04-14 05:02:06 +00:00
Fred Drake 7a64b355c1 For now, comment out the \ignorePlatformAnnotation; the global index 
doesn't really work with this.
 1999-04-13 22:19:21 +00:00
Fred Drake 9444df0844 Don't include the verbatim style; the default handling is better. 1999-04-13 22:17:55 +00:00
Fred Drake 1cc5899742 Fix problem of LaTeX leakage in the module synopsis tables at the 
beginning of chapters.  Known problem reported by Barry Scott
<barry@scottb.demon.co.uk>.
 1999-04-13 22:08:59 +00:00
Fred Drake e331356ff7 Fix availability declaration for popen2 module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 22:03:26 +00:00
Fred Drake b9971b9964 Minor cleanup. 1999-04-13 21:39:31 +00:00
Fred Drake 592dd78408 Fix availability declaration for stat module; report by Barry Scott 
<barry@scottb.demon.co.uk>.
 1999-04-13 21:38:02 +00:00
Fred Drake 31ec33ed60 Work around problems with HTML conversion by making the break and 
tbreak synopses be all on one line (each).  Known problem, most
recently reported by Barry Scott <barry@scottb.demon.co.uk>.
 1999-04-13 21:36:44 +00:00
Fred Drake cc10e0469a Just in case a copy of the documentation gets released somehow... 1999-04-13 21:22:46 +00:00
Fred Drake 07bd1d1b7b Ignore the doc/ directory ("Documenting Python"). 1999-04-12 15:41:44 +00:00
Fred Drake bfb092eb86 Misspellling: "occurance" --> "occurrence" 1999-04-09 19:57:09 +00:00
Fred Drake 2e1094e4ef Use #!/usr/bin/env python instead of #!/usr/local/bin/python. 1999-04-09 14:53:35 +00:00
Guido van Rossum 7969f31c4d Updated documentation by Per Cederqvist. I've added back the 
documentation sendmail() to reflect the changes by The Dragon
(see smtplib.py checkin).
 1999-04-07 15:56:51 +00:00
Fred Drake 4f21d54764 Added more "See also" entries, + 1 inline hyperlink. 1999-04-05 22:18:12 +00:00
Fred Drake ea003fcc2a Fixed latex2html weirdness with footnotes. 1999-04-05 21:59:15 +00:00
Jeremy Hylton 45b0aeda3c correct version info for zlib. 
add note about module failing with old versions of the library.

update comment that explains that this doc is *still* out of date
 1999-04-05 21:55:21 +00:00
Fred Drake 93aa0f23a7 Fixed latex2html weirdness with footnotes. 1999-04-05 21:39:17 +00:00
Fred Drake b55ce1e8b6 Fixed latex2html weirdness with footnotes. 1999-04-05 21:32:52 +00:00
Fred Drake 52e2d51ef3 Fixed latex2html weirdness for a footnote. 1999-04-05 21:26:37 +00:00
Fred Drake 9aa8543c84 open() description: Made it more clear that 'b' should always be 
added to the mode value for binary files to improve
	portability.

Fixed latex2html weirdness with a couple of footnotes.
 1999-04-05 21:22:41 +00:00
Fred Drake 01553706bf Added a few items to the "See also" sections at Guido's prompting. Made 
more references to other modules in the text hyperlinks for the HTML and
PDF versions.
 1999-04-05 19:46:21 +00:00
Fred Drake 766e0cbde1 Added "doc" target to match the other document-prefix targets. 1999-04-05 19:28:29 +00:00
Fred Drake 50ae47b0de Removed bosities around example code; not sure where that stuff crept 
in!
 1999-04-05 19:26:16 +00:00
Fred Drake 1dc3a501a6 Made improvements based on changes just made and comments from 
Bernhard Reiter <bernhard@csd.uwm.edu>.
 1999-04-05 19:00:54 +00:00
Fred Drake 275e83489e Added "Documenting Python" to the index. 1999-03-30 13:43:54 +00:00
Fred Drake 2c4e009b66 Fixed a lot of the smaller nits identified in Guido's comments. 
Filled in some of the "blank" areas, and added another large blank
area for a LaTeX primer.  (Still a lot to be done.)
 1999-03-29 14:55:55 +00:00
Fred Drake 806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +00:00
Fred Drake 7c6a90de8a Added some rules that affect those little "See also:" sections. 1999-03-25 22:22:45 +00:00
Fred Drake bb584d3f6e Be more stylesheet friendly. 1999-03-25 22:18:30 +00:00
Fred Drake a608a1df87 Require the verbatim package (similar to the LaTeX version). 1999-03-25 22:17:29 +00:00
Guido van Rossum cb1f2420ea Document complex() with string arg. 1999-03-25 21:23:26 +00:00
Guido van Rossum 5fc9c869dd SIGTERM is no longer caught to call sys.exitfunc. 
This change was made long ago but the documentation was never updated.
 1999-03-25 20:30:00 +00:00
Fred Drake 2cafcbb440 Remove \platformof support, since it's been removed from the LaTeX 
style sheet.

Small nits.
 1999-03-25 16:57:04 +00:00
Fred Drake e82f5b3d6e Added note about ftpmirror.py, since that seems to be one of the most 
requested Python tools/examples.
 1999-03-25 05:04:17 +00:00
Fred Drake 9b8afdee44 Use more recent option to \pdfdest to not change the zoom factor. 
This is in response to a comment from Wes Rishel <wes@rishel.com>.
 1999-03-24 14:16:17 +00:00
Guido van Rossum 8be229650d Document new builtin buffer(). Greg Stein. 1999-03-19 19:10:14 +00:00
Fred Drake 7d5f5dd6aa Added htmldoc, to generate the HTML for "Documenting Python". 1999-03-18 19:08:47 +00:00
Fred Drake 1468d77ff8 Add "Documenting Python" to the list of processed documents. 1999-03-18 19:07:04 +00:00
Fred Drake 03dffcce0e LaTeX2HTML support for the ltxmarkup package. 1999-03-18 16:42:28 +00:00
Fred Drake 9466b9a10d Add some (commented out) macros to change the page size to the size of 
typical published manuals, so people can more easily see what they're
really asking for.  ;-)

Revise the verbatim environment: simple implementation, but more
compatible if a document also add \usepackage{verbatim} at the
beginning.

Declare \modindex, \bimodindex, \exmodindex, and \stmodindex
obsolete.  These still work just fine, but \declaremodule should be
used instead.  The obsolete macros will print a warning on standard
out.
 1999-03-18 16:18:27 +00:00
Fred Drake 596766772e Documented FTP.set_pasv(). 1999-03-18 16:08:54 +00:00
Fred Drake e3fd1064de Make this simpler; don't care about the paper size. Require that the 
files exist in the current directory.

Add "Documenting Python" to the list of documents listed.
 1999-03-18 14:57:53 +00:00
Fred Drake 154d909993 Note that abspath() was added in 1.5.2. 1999-03-17 22:25:11 +00:00
Fred Drake 90fc0a71a5 Be sure "make" understands the "doc" target is phony. 1999-03-17 16:06:51 +00:00
Fred Drake 8d2c0c2ab4 Fixed minor nits, added index entries to make these easier to find for people 
not familiar with Unix terminology.
 1999-03-16 16:40:01 +00:00
Fred Drake c43e6a2f31 Ignore some more files kept by mkhowto --keep. 1999-03-16 16:14:51 +00:00
Fred Drake 15087437d5 Add support for "Documenting Python". 1999-03-16 16:11:27 +00:00
Fred Drake 8df362cf97 Removed the embedded sections showing module documentation; just 
\input the module template.
 1999-03-16 16:10:31 +00:00
Fred Drake acffaee46e New document: "Documenting Python". 1999-03-16 16:09:13 +00:00
Fred Drake 1d8f07acbd Markup for documenting LaTeX macros and environments. 1999-03-16 16:08:26 +00:00
Fred Drake f03fdbc063 Added the new sections from Skip Montanaro. 1999-03-15 15:47:30 +00:00
Fred Drake 658cef0141 Preliminary mhlib and telnetlib documents from Skip Montanaro -- thanks, Skip! 1999-03-15 15:44:18 +00:00
Fred Drake bf5a6d2eb4 Fixed tons of small markup problems. 1999-03-12 19:57:38 +00:00
Fred Drake b3a20bc44c Added availabililty annotations to respond to concerns of /F. 1999-03-12 18:34:21 +00:00
Fred Drake 4b1a07ae18 Fixed grammatical error reported by Donald Wallace Rouse II 
<dwr2@ix.netcom.com>.
 1999-03-12 18:21:32 +00:00
Fred Drake 93503ca57b Fixup the module keys. There were some problems with hosting / processing 
file HTML files on Windows machines do to case insensitivity.
 1999-03-12 16:24:22 +00:00
Fred Drake be110c1706 Updates based on comments from /F. 1999-03-12 15:27:35 +00:00
Fred Drake 87a42cd61b Add support for <platform>, some cleanup of module section after 
creating the <moduleinfo>.
 1999-03-11 17:35:12 +00:00
Fred Drake ee84d5972f Lots of nits to respond to various comments from users. 1999-03-10 17:25:30 +00:00
Fred Drake dc12ec8ca0 Fix a number of typos and small grammatical nits pointed out by Detlef 
Lannert <lannert@lannert.rz.uni-duesseldorf.de>.

Added a comment explaining the cast in the method table for the
keyword arguments sample code, in response to another comment by
Detlef.
 1999-03-09 18:36:55 +00:00
Fred Drake 39fc1bc329 Added note about __builtin__._ to section dicussing classes of 
reserved names, just to avoid confusion on the part of users.
 1999-03-05 18:30:21 +00:00
Fred Drake 1acb8740eb Oops, missed a couple of substitutions in the templates. 1999-03-04 21:33:55 +00:00
Fred Drake b41f97d6a0 Pass in the 'Send comments to ...' on the mkmodindex command line, 
just like we do for mkhowto.
 1999-03-04 21:25:05 +00:00
Fred Drake 5f7832d125 Allow many more aspects of the generated page to be parameterized, and 
add a useful usage message.  Use 'mkmodindex --help' to display it.
 1999-03-04 21:19:57 +00:00
Fred Drake 6de28bd2a8 Added "Internet Config" to index. 1999-03-04 19:00:26 +00:00
Fred Drake 62cc360e38 add_module_idx(): If \ignorePlatformAnnotation is used, only ignore 
the specified annotation, not any annotation.
 1999-03-04 18:41:17 +00:00
Fred Drake 35c3ffdc3f Fixed description of WSTOPSIG(), added WTERMSIG(). Problem reported 
by Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-03-04 14:08:10 +00:00
Fred Drake aaa0d9a3a4 Record the value of $TEXINPUTS in the transcript. 
Job.message():  New method.  Takes care of writing a message to the
		user and adding it to the transcript.
 1999-03-03 21:57:58 +00:00
Fred Drake d8ee0e6ca5 Oops, missed version number for pdfTeX. Updated. 1999-03-03 21:44:10 +00:00
Fred Drake 41dee84a40 Lots of small updates. 1999-03-03 21:39:19 +00:00
Fred Drake b1d839866c Obsolete; use the Python version instead. 1999-03-03 20:28:17 +00:00
Fred Drake 6b12b1ec1d Switch to the Python version of mkhowto. 1999-03-03 20:27:10 +00:00
Fred Drake 8b88093b95 Re-written mkhowto in Python; this should be at least a little more 
portable.

Several things that had been done by running a python script are now a
matter of importing the right module and running a function with a few
parameters.
 1999-03-03 20:24:30 +00:00
Fred Drake 749f943a6b process(): New function that contains the "orchestration" of the 
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
 1999-03-03 19:36:23 +00:00
Fred Drake 7c8754fafb process(): New function that contains the "orchestration" of the 
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
 1999-03-03 19:25:56 +00:00
Fred Drake aa99a5071e Be a little more friendly for the generation of the text version: for 
"blank" navigation icons, use ALT="" instead of ALT="blank"; also add
ALIGN=CENTER for the table, to get a slightly better affect in the
text (the table is full-width, so this doesn't change the appearance
when browsing the HTML).
 1999-03-03 16:21:34 +00:00
Fred Drake a54a887f66 "\platform{UNIX}" should really be spelled "\platform{Unix}". 1999-03-02 17:03:42 +00:00
Fred Drake f6863c1909 Added \platform annotations. 1999-03-02 16:37:17 +00:00
Fred Drake 46a9438c43 Add information about adding the portability statement. 1999-03-02 16:24:22 +00:00
Fred Drake 7f492ad7b8 Be more flexible to support platform annotations. 1999-03-02 16:22:56 +00:00
Fred Drake 75ab7a6fa4 Clean up *.pla files -- platform annotation information. 1999-03-02 16:22:26 +00:00
Fred Drake 521835c541 Ignore *.pla -- the platform annotation information. Also, remove it for 
'make clean'.
 1999-03-02 16:20:42 +00:00
Fred Drake d70091eade Ignore *.pla -- the platform annotation information. 1999-03-02 16:19:37 +00:00
Fred Drake 0c275fa856 Added support for \platform, \platformof, and \ignorePlatformAnnotation. 1999-03-02 16:17:44 +00:00
Fred Drake 557460cb7a swallow_newline(): Removed function; not really needed. Modified all call 
sites.

do_cmd_ignorePlatformAnnotation(),
do_cmd_platform(),
do_cmd_platformof():  New functions to support platform dependency
		      information.

process_all_platformofs():  New function to post-process \platformof macros
	using information collected during the initial pass.

process_python_state():  New function. Call all post-processing functions
	defined in this file to avoid having to have too much knowledge of
	the internals for this stuff in l2hinit.perl.
 1999-03-02 16:05:35 +00:00
Fred Drake 2383f6dbbc Improve handling of module index, to deal with platform annotations a little 
better.
 1999-03-02 16:00:37 +00:00
Fred Drake 01bc01c82e Changes to accomodate the global module index and platform annotations. 1999-03-02 15:58:20 +00:00
Fred Drake 368b16ad2b Only use 4 columns in the module index, to accomodate platform annotations. 1999-03-02 15:56:19 +00:00
Fred Drake 43b34da656 extract_tb(): Only describe this function once. Problem reported by 
Jonathan Giddy <jon@dgs.monash.edu.au>.
 1999-02-26 18:51:21 +00:00
Fred Drake 390636382a Typo: "Availabilty" --> "Availability" 
Thanks to /F!
 1999-02-26 14:05:02 +00:00
Fred Drake 51027c4173 Added note about comments, from Christopher Petrilli. 1999-02-24 22:36:44 +00:00
Fred Drake 16e81f4484 Update some of the top comments and shorten title of the first 
section.
 1999-02-24 19:57:14 +00:00
Fred Drake 093c97a36f ignore_from_idx(): Fixed bug in regular expression. 1999-02-24 18:39:47 +00:00
Fred Drake 684f78fafe Add target for modindex.html; a combined lib+mac module index. Also 
built with target "all".
 1999-02-24 17:34:12 +00:00
Fred Drake 2ef38a7a42 Script to combine module index files. Given a list of files that look 
like modindex.html, create a combined modindex.html file that lists
all the modules.  Takes the same parameters as buildindex.py.
 1999-02-24 17:33:07 +00:00
Fred Drake 1b102456a6 Ignore a file called modindex.html. 1999-02-24 17:13:54 +00:00
Fred Drake 711fe02ac3 process_nodes(): New function. 
main():  Moved the node processing between input and ouptut to
	 process_nodes().
 1999-02-24 16:36:48 +00:00
Barry Warsaw f2b4554403 Document the correct class hierarchy for SystemExit. It is not an 
error and so it derives from Exception and not SystemError.
 1999-02-24 00:27:14 +00:00
Fred Drake b6cf9a4fc4 Script to help identify undocumented modules. Use -h or --help for 
usage information.
 1999-02-23 23:07:48 +00:00
Fred Drake 8cdee961bf Dictionaries are created using the "{...}" notation, not the "..." 
notation.  Problem reported by Magnus L. Hetland <mlh@idt.ntnu.no>.
 1999-02-23 18:50:38 +00:00
Guido van Rossum 264bd59221 1. Clarify that immutability isn't entirely the same as unchangeable 
value (because of immutable containers containing mutable objects).

2. Document that func_code, func_defaults and func_doc / __doc__ are
now writable.
 1999-02-23 16:40:55 +00:00
Fred Drake 1ec71cb556 Incorporated updates to describe geturl() by Sjoerd Mullender 
<Sjoerd.Mullender@cwi.nl>.
 1999-02-22 22:42:14 +00:00
Fred Drake ba21d10d9b Added note about *static* after description of *shared*. 1999-02-22 18:21:17 +00:00
Fred Drake 00a3a65cc0 Refer to the right RFC in the intro. 1999-02-22 17:12:42 +00:00
Fred Drake 0fb7a37667 Reflect the released version. 1999-02-22 15:58:09 +00:00
Fred Drake 9226d8e8a8 Removed "This will be discussed later." where it's not. Reported by 
Clay Spence <cspence@sarnoff.com>; see entry in ../TODO.
 1999-02-22 14:55:46 +00:00
Fred Drake 7d9b13325d Other chapter titles refer to collections of modules as "Services"; do 
the same here.
 1999-02-22 14:48:00 +00:00
Fred Drake 8ece8041c5 Noted report of missing material in the extending & embedding manual, 
as reported by Clay Spence <cspence@sarnoff.com>.
 1999-02-22 14:37:18 +00:00
Fred Drake c411fa6861 Revised description of blank line handling for the interpreter, based 
on a comment from /F.
 1999-02-22 14:32:18 +00:00
Fred Drake fab41f1788 BabylMailbox description: Properly escape the backslashes in the 
string representations.
 1999-02-22 14:26:16 +00:00
Fred Drake b63e77ccb0 Oops, used a \label twice - fix one of them. 1999-02-22 14:14:48 +00:00
Fred Drake 180b68b3cf More reasonable section titles. 1999-02-22 13:45:09 +00:00
Fred Drake 76991ec75a Shorten section title. 1999-02-20 05:20:49 +00:00
Fred Drake 199b79c37b Added descriptions for BabylMailbox and Maildir (Qmail) mailbox 
objects.
 1999-02-20 05:04:59 +00:00
Fred Drake 67d229ea76 Shorten section title. 1999-02-20 04:51:16 +00:00
Fred Drake bbac43223c Shorten a few section titles. 1999-02-20 00:14:17 +00:00
Fred Drake da57365337 Give subsections reasonable file names in the HTML. 1999-02-19 23:48:05 +00:00
Fred Drake 342501142d Added an index entry. 1999-02-19 23:45:06 +00:00
Fred Drake 50cdd97ec4 do_cmd_arabic(): Override the l2h-provided version to remove that 
obnoxious <SPAN CLASS="arabic">...</SPAN> markup.
 1999-02-19 23:04:59 +00:00
Fred Drake df5d50d889 Specify the sizes of H? relative to the normal font size as 
percentages; using "large", "x-large" makes them too big for
some troublemakers.  ;-)

(Not specifying them at all causes some browsers to make them the same
size as normal text.  ;-(  )
 1999-02-19 23:03:04 +00:00
Fred Drake 56f8185a53 Shortened the short synopsis -- too long. 1999-02-19 22:59:56 +00:00
Fred Drake 9f03380d1c Use more current approach to recording authors. 1999-02-19 22:56:08 +00:00
Fred Drake c60047575d Shortened the short synopsis -- way too long. 1999-02-19 22:33:51 +00:00
Fred Drake d8a41e6391 Fix an amazing number of typos & malformed sentences reported by Detlef 
Lannert <lannert@uni-duesseldorf.de>.
 1999-02-19 17:54:10 +00:00
Fred Drake f6346345b0 Noted that the module was added in 1.5.2. 1999-02-19 15:46:38 +00:00
Fred Drake 4e7c205470 Update description of what modules "look like" when printed. 1999-02-19 15:30:25 +00:00
Fred Drake cd71aa2a38 Use current approach to record documentation author. 1999-02-18 21:13:03 +00:00
Fred Drake 2a2f1fe4d5 Record module & documentation author. 1999-02-18 21:10:32 +00:00
Fred Drake 6b103f1e12 Documentation for pyclbr and tokenize modules. 1999-02-18 21:06:50 +00:00
Fred Drake 4d358b5d23 Added sections for pyclbr and tokenize. 1999-02-18 20:40:26 +00:00
Fred Drake 7c829b3179 Remove the "Parsing Python" section. Hurray! 1999-02-18 20:39:44 +00:00
Fred Drake 3d7707a87d More files. 1999-02-18 20:39:04 +00:00
Fred Drake 93d762fc7a Mark <verbatim> elements that represent interactive sessions; these 
become <interpreter-session> elements.
 1999-02-18 16:32:21 +00:00
Fred Drake 997eec7cca Minor adjustments to reflect esis2sgml.py changes. 
Added "esis" target to only generate the ESIS data.
 1999-02-18 16:31:05 +00:00
Fred Drake 607aed7a2c Some adjustments, mostly to make it more general. 1999-02-18 16:30:16 +00:00
Fred Drake 4cc902f464 Make the _rmtt regular expression deal with the new CSS-friendly 
changes to the HTML documentation.
 1999-02-18 16:11:12 +00:00
Fred Drake 70a66c9d6d Add notes to __builtin__.float() and string.atof() that the NaN and Inf 
results are possible but non-portable.
 1999-02-18 16:08:36 +00:00
Fred Drake 29fb54f0ca Update note about the (...) format specifier for PyArg_ParseTuple(). 1999-02-18 03:50:01 +00:00
Fred Drake 951eea4733 atof() description: Add information about accepting 'NaN' to produce 
the NaN value.
 1999-02-18 03:49:20 +00:00
Fred Drake 127ed0a71e Updated list of standard exceptions in section 4.1. 1999-02-17 23:09:05 +00:00
Fred Drake 8e0151725d Small updates and grammatical adjustments. 
Remove comment about this manual being out of date from the abstract.
 1999-02-17 18:12:14 +00:00
Fred Drake 33698f818b Removed old dynamic linking chapter. 
Integrated information on Windows DLLs from Chris Phoenix (Thanks!).

Added "Acknowledgements" area to thank contributing authors.
 1999-02-16 23:06:32 +00:00
Fred Drake 2f7bfafe26 Remove all email addresses. 1999-02-16 22:51:09 +00:00
Fred Drake 3de61bc13f Integrated notes on building extension modules on Windows, by Neil 
Schemenauer <neil_schemenauer@transcanada.com>.

Thanks, Neil!
 1999-02-16 21:14:16 +00:00
Fred Drake f6838c0f5e Copy in the stylesheet after latex2html is done. 1999-02-16 20:43:53 +00:00
Fred Drake fcf57ad959 Copy in the stylesheet after latex2html is done. 1999-02-16 20:28:25 +00:00
Fred Drake 90fdda5404 Become more stylesheet-friendly. 1999-02-16 20:27:42 +00:00
Fred Drake 00d98ee5cc CSS style sheet for the documentation. 1999-02-16 20:27:08 +00:00
Fred Drake 63f217741e Bump release to 1.5.2b2. 1999-02-16 20:23:55 +00:00
Fred Drake f43ce00531 Make sure errors get propogated. 1999-02-16 20:05:43 +00:00
Fred Drake 85a59dd68b The _O_* constants are defined as O_* in the os module. 1999-02-16 19:41:01 +00:00
Fred Drake 9329e5ec75 Remove "_" from the P_* symbols used with the spawn*() functions. 1999-02-16 19:40:19 +00:00
Fred Drake c7b72dbbca Added chapter on Windows modules, including msvcrt and winsound. 1999-02-16 19:18:38 +00:00
Fred Drake a5fab7f8c8 Added some files to the library reference. 1999-02-16 19:08:16 +00:00
Fred Drake abfd7d6701 Small grammatical fix; missing comma. 1999-02-16 17:34:51 +00:00
Fred Drake 295fb434ed Make it clear that Demo/embed/ is from the source distribution. 1999-02-16 17:29:42 +00:00
Fred Drake beb27bfef7 Make navigation panels more CSS-friendly. 
Make sure the contents page always has the "table of child links"
turned off; this wasn't being handled properly by latex2html for
"howto" ("article") documents, so just do it ourselves for all
document types.
 1999-02-16 17:22:32 +00:00
Fred Drake e96a31da96 Use the same markup for email addresses as is produced by using \email 
in the LaTeX sources.
 1999-02-16 16:16:37 +00:00
Fred Drake cce8d2a85a Adjust cellspacing attribute of the navigation bar tables to get some 
space between cells on all (major) browsers.
 1999-02-16 14:21:54 +00:00
Fred Drake 6f9dd5d719 Remove stuff related to copying the icons directory around -- just 
isn't needed.
 1999-02-15 21:43:55 +00:00
Fred Drake b8a7d72857 Moved icons into the html directory to avoid pollution of the top level. 1999-02-15 21:42:47 +00:00
Fred Drake 66b989c805 Be explicit about the reference count of the original value of the 
first parameter to PyString_Concat().
 1999-02-15 20:15:39 +00:00
Fred Drake 4d33e4e1a8 HTMLBASE: New variable. Make it easier to check an "installed" copy 
of the HTML documents using the webcheck target.

When there's not a usable .aux file, use mkdvi.sh --aux instead of
building the .dvi completely.  This makes the most difference for the
library reference.
 1999-02-15 19:29:08 +00:00
Fred Drake efa641c45a Add an optional parameter to make the script run latex only once to 
generate an .aux file.  This can make HTML generation a bit faster
when print formats aren't needed.

Explained parameters in a comment.
 1999-02-15 19:27:07 +00:00
Fred Drake 3618c14f72 Use a common definition for $(SUBMAKE) instead of repeating everything 
all over the place.
 1999-02-15 16:50:28 +00:00
Fred Drake aa1afa8d30 Added availability notes for samefile(), sameopenfile(), samestat() 
since these are not available on Windows.
 1999-02-15 16:34:00 +00:00
Fred Drake 5d59d3df7f Added --l2h-config option to add additional initialization files for 
latex2html.  Can be useful in setting up things like the upward
external link for the top of the documents.
 1999-02-15 16:27:42 +00:00
Fred Drake ec9fbe90be Added section "Providing a C API for an Extension Module" by Konrad 
Hinsen.

"\C{}" --> "C"
 1999-02-15 16:20:25 +00:00
Fred Drake efd146c916 Markup nits. 
Added section on module objects; described functions in
moduleobject.c.
 1999-02-15 15:30:45 +00:00
Fred Drake 69d49d6378 Set target. 1999-02-15 15:02:21 +00:00
Fred Drake f32834c206 Minor fix that helps out with the index. 1999-02-12 22:06:32 +00:00
Fred Drake 9474d86242 Make sure all HTML pages generated from this section have reasonable 
names.

Markup nits.
 1999-02-12 22:05:33 +00:00
Fred Drake 5761b766b2 L2HARGS: Specify the HTML version we're producing, since this is what 
we generate anyway.
 1999-02-12 21:42:23 +00:00
Fred Drake 2d2b6a0074 Markup nits. 1999-02-12 20:40:49 +00:00
Fred Drake 99cd5735f0 Minor markup nits. 1999-02-12 20:40:09 +00:00
Fred Drake 7b84972450 Use the shorter form of Christopher Petrilli's email address. 1999-02-12 20:09:59 +00:00
Fred Drake 28bc711f5f Added section for MimeWriter, contributed by Christopher Petrilli 
<petrilli@amber.org>.

This spells the end of another whole section in the undoc chapter!
 1999-02-12 19:26:09 +00:00
Fred Drake f7bf3b2b06 Added entry for MimeWriter module. 1999-02-12 19:24:02 +00:00
Fred Drake 15799edd34 Make table headers the same color as the navigation bars so they stand 
out a little better.

Make sure the boxes for the last column of tables always get drawn;
these are often left empty of content when used as a "Notes" column.
They look a little better this way.
 1999-02-12 19:23:17 +00:00
Fred Drake 7a9ed71e95 Moved the navigation-bar background color to a variable. 1999-02-12 19:00:38 +00:00
Fred Drake 26b698fa4d Document <complex #>.conjugate(). 1999-02-12 18:27:31 +00:00
Fred Drake 15988fdbbb Documented __complex__(), made sure all the discipline names hit the 
index.
 1999-02-12 18:14:57 +00:00
Fred Drake 2e1ee3eb19 Fix up some routines to coordinate the "indexsubitem" stuff so that 
the subitem text is updated correctly when each module section is
processed.

Print [<modulename>] when we start on \declaremodule so we can more
easily track progress during the library reference.
 1999-02-10 21:17:04 +00:00
Fred Drake 72e5a901c2 Remove unnecessary <p> from top navigation bar. 1999-02-10 17:35:41 +00:00
Fred Drake ec5c0b41ae Revert previous change; there's a better way to do it. 1999-02-10 17:08:00 +00:00
Fred Drake 95474f9696 Change the navigation bar to be a little prettier and more consistent 
with the python.org style.
 1999-02-09 18:45:50 +00:00
Fred Drake 446ab75fcf New blank icon to match the others in size & color, with without any 
symbol on it.
 1999-02-09 18:27:21 +00:00
Fred Drake 2d1f81ea22 do_cmd_maketitle(): Small nit in creating the "title page". 1999-02-09 16:03:31 +00:00
Fred Drake 1a4c5392b5 Back out some of the fine tuning; something in all that interacted 
badly in practice and botched the whole thing.  Wasn't obvious when
looking at the local effects (which worked), but completely broke
entire pages.  ;-(
 1999-02-09 15:31:52 +00:00
Guido van Rossum ce67f06491 Update documentation to reflect changes to Queue.py by Tim Peters. 1999-02-08 18:43:13 +00:00
Fred Drake dfb4e24431 Respond to suggestion from "Albert" <hat@se-46.wpa.wtb.tue.nl> to add 
document titles to the list of files.

Also added total page count and a note that comments should be
directed to python-docs@python.org.
 1999-02-05 20:50:59 +00:00
Fred Drake 2ff880e2cf More magic to tighten up a little of the formatting. 1999-02-05 18:31:29 +00:00
Fred Drake f9918f25b1 Minor nit to prevent dropping a space in the HTML generation. 1999-02-05 18:30:49 +00:00
Fred Drake d673d481f5 Document sameopenfile(), samestat(). 1999-02-03 22:31:30 +00:00
Fred Drake 0256c1f453 Document splitdrive(). 
For all split*(), these split path *into* pairs, not split path *in*
pairs.  "Into" can be used for transformations, "in" is for
containment.
 1999-02-03 19:24:44 +00:00
Guido van Rossum 0c9608cf1b Portability fix for [f]statvfs() return tuple: no longer return the 
f_fsid field, since it's not a scalar on all systems supporting this
call (in particular, it's a tuple of two longs on AIX).  Since it's
not particularly useful, just nuke it.  Adapted the doc strings too.
 1999-02-03 16:32:37 +00:00
Fred Drake dbd37dfcff Remove three items. 1999-02-02 19:03:09 +00:00
Fred Drake 215fe2f204 Fix the os/posix documentation issue. 1999-02-02 19:02:35 +00:00
Fred Drake dda199b261 Moved \versionadded to end of description sections. 1999-02-02 19:01:37 +00:00
Fred Drake 12ba7868e4 Moved posixpath to os.path. 1999-02-02 19:00:37 +00:00
Fred Drake 560bcae0f0 Added posixpath, winsound. 1999-02-02 18:59:58 +00:00
Fred Drake a9b9bf96fe Change this to be os.path. 
Use consistent parameter naming with the os documentation (paths
always named "path" or "path1", "path2"...).
 1999-02-02 18:58:33 +00:00
Fred Drake bb79438d26 This seems to fix a problem with targeting from the indexes. 1999-02-02 18:57:12 +00:00
Fred Drake 2116d983bf Make \versionadded and \versionchanged less prominant -- neither bold 
nor a separate paragraph.
 1999-02-02 18:02:48 +00:00
Fred Drake d0bceeeb59 Move \versionadded macros to end of descriptions. 1999-02-02 18:00:40 +00:00
Guido van Rossum 09da65ef2f Patch by Sjoerd Mullender to placate /F: 
Clarified (hopefully :-) the documentation of elements and attributes
variables.
 1999-02-02 17:55:12 +00:00
Fred Drake dbd72a4e4f Added module synopsis. 1999-02-01 21:27:59 +00:00
Fred Drake 68a8c69499 Take out just about everything and refer the reader to the os module. 1999-02-01 20:23:02 +00:00
Fred Drake b23ee1d899 Make the text generic, and call it os.path instead of posixpath. 1999-02-01 20:20:39 +00:00
Fred Drake 59d8b73cef Remove all references to posixpath; only refer to os.path. 
Formalize the xstat() documentation.
 1999-02-01 20:19:38 +00:00
Fred Drake 98be47e737 OSError description: "as the by the" --> "as the" 1999-02-01 16:17:40 +00:00
Fred Drake 7281b3b779 Updated comments on version of XML package needed. 1999-01-29 22:35:23 +00:00
Fred Drake 28e66d1c5e Added the info tarball to the tarballs target. Added the README to 
the info tarball.
 1999-01-29 22:23:25 +00:00
Fred Drake b2c59ab367 A README file for the info tarball. 1999-01-29 22:22:03 +00:00
Fred Drake 1dd152d036 Added support to handle \versionadded in a reasonable way. 1999-01-29 22:12:29 +00:00
Fred Drake 9b0dc53d89 Define %descriptor.class, since it's used. 1999-01-29 21:38:14 +00:00
Fred Drake 279ca75a5b Be a little smarter on some attribute values, making an assumption about 
the DTD.
 1999-01-29 21:35:50 +00:00
Fred Drake 3a7ff998ac fixup_descriptors(): Change the way we look for descriptor nodes; 
this takes 5 minutes off the conversion of the whole tree by
	reducing the number of tree-traversals from 14 to 1.
 1999-01-29 21:31:12 +00:00
Fred Drake 666e60095b Added the Doc/sgml/ directory to the tarball. 1999-01-29 21:22:55 +00:00
Fred Drake cb65781d93 Rewrite code that converts the little descriptor environments to build 
the right <signature>s and <description>.  This seems to work a lot
better now!
 1999-01-29 20:55:07 +00:00
Fred Drake 75930b31e2 Added table entries for \funcline and \funclineni. 1999-01-29 20:09:27 +00:00
Guido van Rossum 1804dc3c07 Document abspath() (implementation is forthcoming). 1999-01-29 18:05:05 +00:00
Fred Drake f339632da0 Define a general entity "&version;" that can be used as the current major 
version of the Python interpreter.  This is \version in the LaTeX format
of the documentation.
 1999-01-29 16:42:37 +00:00
Fred Drake fdfd50f815 Convert <version> to &version;. 1999-01-29 16:29:25 +00:00
Fred Drake 7859f17608 A few scribbles toward the DTD. 1999-01-29 16:21:20 +00:00
Fred Drake 6bcc53c109 Standard ISO entities. 1999-01-29 16:20:24 +00:00
Fred Drake 2eb07f0945 The OASIS Exchange table model public text. 1999-01-29 15:57:31 +00:00
Fred Drake 7dab6affba Update the docstring. 
Lots of changes to get the paragraph marking to work, and not go into
an infinite recursion.

Start to rationalize markup of method signatures; not complete.

find_all_elements():  similar to getElementsByTagName(), but operates
	on the not-quite-legal fragments we deal with here.
	Simplifies several individual transforms.

fixup_sectionauthors():  Convert \sectionauthor items to <author> just
	after the <section>'s <title>.
 1999-01-28 23:59:58 +00:00
Fred Drake 3f3b09657f Added table entries for \methodline, \methodlineni. 1999-01-28 23:49:37 +00:00
Fred Drake ae3e574170 "numberic" --> "numeric", two places 1999-01-28 23:21:49 +00:00
Fred Drake 1453a8caf9 Constructor arguments for classes should be called <args>. 1999-01-28 23:10:48 +00:00
Fred Drake 703b70e260 Added \modulesynopsis. 1999-01-28 19:30:49 +00:00
Guido van Rossum 6b86a42c7f Document -OO; "unsafe" optimization that removes docstrings. 
Marc-Andre Lemburg.
 1999-01-28 15:07:47 +00:00
Fred Drake ffd511248e Add the info "dir" fragment to the info tarball. 1999-01-27 18:50:21 +00:00
Fred Drake 8d7919d754 Fragment of an info "dir" file for the Python documentation. 1999-01-27 18:49:44 +00:00
Fred Drake ffc4811a40 Simplify slightly. 1999-01-27 18:40:36 +00:00
Fred Drake c5efde8522 Don't build info for the Macintosh module reference by default; it 
doesn't do well.
 1999-01-27 18:30:16 +00:00
Fred Drake aa2aea0e79 \py@linkToName: New macro to consolidate support for most internal 
hyperlinking in the PDF version.  This also allows many of the
	macros that do this stuff to be a good bit more readable.
	Takes the target name and link content as parameters.

Use \py@linkToName for all internal links.
 1999-01-27 17:37:36 +00:00
Fred Drake 580f4ab5dc Added the files for the repr and ConfigParser modules. 1999-01-27 17:21:09 +00:00
Fred Drake 9d814c6805 Document the repr module. This removes the entire "Code objects and 
files, debugger etc." section from "Undocumented Modules"!
 1999-01-27 17:20:33 +00:00
Fred Drake da452bf6a7 Don't say that the module defines the "following functions" and then 
only describe one; say "following function" instead!

Merge the two one-sentence paragraphs into a single paragraph, so it
doesn't look too stupid.
 1999-01-27 15:48:23 +00:00
Fred Drake ebe2a12de8 Incorporate changes for patched version of ConfigParser. 1999-01-26 21:49:05 +00:00
Fred Drake 9f253dc3ff \py@modindex: Format the index entry for the module index more like 
that used in the "normal" index.  No visual difference, but
	more easily processed by helper scripts.
 1999-01-26 19:23:09 +00:00
Fred Drake bc866ce2e3 Documentation for the ConfigParser module, by Christopher G. Petrilli 
(petrilli@amber.org).
 1999-01-26 15:47:59 +00:00
Guido van Rossum 9700e9becc Document the default for tabsize in expandtabs(). 1999-01-25 22:31:53 +00:00
Fred Drake a49a4eabbf Add "term" to AUTOCLOSE. 1999-01-22 22:48:24 +00:00
Guido van Rossum d1dbf633ed Header for PyObject_DelItem() mentioned non-existing 3rd argument. 1999-01-22 20:10:49 +00:00
Fred Drake 43278f01dc convert(): Added parameter "autoclose", which should be a sequence of 
general identifiers for which closing tags will be omitted
	when SGML is generated.  This can be used to tell the markup
	generator to drop stuff like </para>.  Note that it needs to
	be possible for the closing tag to *always* be omitted for it
	to be included in "autoclose".

main():  Added command-line option "-a" / "--autoclose" to set the
	list of general identifiers passed to the convert() function
	as the "autoclose" parameter.  The list may only be specified
	once (not additive) and GIs should be comma-separated.  The
	default list includes only "para".
 1999-01-20 20:35:05 +00:00
Fred Drake 0a5b8de5e2 Modified the "sgml" and "xml" targets to stop if the sub-makes fail in 
any subdirectory; don't continue with remaining subdirs.

Added "api", "ext", "lib", "mac", "ref", and "tut" targets to only do
submakes in those directories.  This is just a lot easier to use than
to cd into the subdir and use make.rules directly.
 1999-01-20 17:26:56 +00:00
Fred Drake 19a0dba342 Add caveat on partial dependence on the "cl" module, only available on 
IRIX systems.
 1999-01-20 16:26:09 +00:00
Fred Drake 9ea3e36419 Move the jpeg module to the SGI section; it is dependent on the "cl" 
module available on IRIX.
 1999-01-20 15:55:20 +00:00
Fred Drake 4259f0db04 create_module_info(): If there's a \moduleauthor, move it to an 
<author> inside the <moduleinfo> element.

Fix problems with paragraph identification.
 1999-01-19 23:09:31 +00:00
Fred Drake 36dfe58694 isnmtoken(), istoken(): Fix to ensure the regex has to match the 
entire attribute value.

Add ability to save list of "empty" elements to a file -- enabled by
constant in the code.
 1999-01-19 23:03:04 +00:00
Fred Drake 2664db9f76 handle_labels(): Fix problem for document fragments containing more 
than one "root" that prevented all the <label id=...> items
	from being promoted to id attributes on the enclosing chapter/
	section/... properly.
 1999-01-19 21:46:48 +00:00
Fred Drake a7998f650a Revised comments on null bytes in pattern string. 
Removed "New" from module synopsis.
 1999-01-19 20:00:08 +00:00
Fred Drake 6ffa445832 Fix second description of handling 2-digit years (last item in 
introductory text).
 1999-01-19 19:35:18 +00:00
Fred Drake d6ced7d199 convert(): Change the element name remapping to convert <refmodule> 
to <module link>.
 1999-01-19 17:11:23 +00:00
Fred Drake f82e4ab617 format_attrs(): Attempt a bit more minimization for SGML output. 1999-01-19 17:10:31 +00:00
Fred Drake 9bbdce5945 add_module_idx(), add_idx_hook(): 
Change the message printed before running buildindex.py;
	"Doing the index..." wasn't clear and could be misinterpreted
	with an inappropriate mindset.  ;-)
 1999-01-19 16:30:10 +00:00
Fred Drake 7eca8e5017 Fix typo spotted by Jeff MacDonald <jam@ans.net>. 1999-01-18 15:46:02 +00:00
Fred Drake 589bc63e84 Add a "tarball" target. 1999-01-14 22:35:05 +00:00
Fred Drake 6038f54b74 Adjust so that we are no longer using special entities for well-known 
names.  These are too much of a pain for occaissional authors.
 1999-01-14 21:44:56 +00:00
Barry Warsaw 53610caee2 for method getaddrlist(): Added a note clarifying that all named 
headers and their continuation lines are parsed.
 1999-01-14 21:26:54 +00:00
Fred Drake 3effeedad3 Shorten the name of the <rfc> "number" attribute to "num". 1999-01-14 21:18:52 +00:00
Fred Drake d24167baf2 Make <rfc> no longer an empty element but a container. The text 
currently generated by the LaTeX and LaTeX2HTML processes is generated
here as well, making it more flexible in the SGML version.

Reduce the <args> element so that <optional> goes away; just use
square brackets to indicate what's optional.  This makes it easier to
read than the LaTeX, and the processor can do any checking it needs to
in order to make sure it's legit.  Possible shortcoming: DSSSL
processors may need more explicit markup.  Can probably hack around it
for this case, but we'll see.
 1999-01-14 21:18:03 +00:00
Fred Drake f8ebb5521d Several new functions to re-write tables to be at least partly 
conformant with the OASIS Exchange model.  There's a little more
massage left to do, but not much.
 1999-01-14 19:45:38 +00:00
Fred Drake a50a1df588 Added clean and clobber targets. 1999-01-14 18:26:23 +00:00
Fred Drake 54bad44f25 Update to the latest version of Michael Ernst's script. 1999-01-14 18:17:07 +00:00
Fred Drake 3a7a3d745d "Driver" makefile to convert all documents to SGML or XML at once. 1999-01-14 18:13:59 +00:00
Fred Drake 7727416686 Add usage of the "driver" Makefile. 1999-01-14 18:12:33 +00:00
Fred Drake 9d1c3b565f Elaborate a comment on the format of the table that drives the 
conversion.
 1999-01-14 18:10:09 +00:00
Fred Drake d7acf02290 Adjustments to allow elements with subelements as parameters. This is 
used to deal with the table headings and entries.

An additional flag in the element table is used to indicate elements
which have no "general" content, but which do have subelement
content.  These must be flagged distinctly from empty elements.
Currently used for \lineii, \lineiii, and \lineiv.
 1999-01-14 17:38:12 +00:00
Fred Drake 79cbadc194 Added fixinfo.el to the list of dependencies. 1999-01-14 17:13:03 +00:00
Fred Drake 79ad1f19dc Escape special characters on output. 1999-01-14 17:06:09 +00:00
Fred Drake da71e315bb Update the comments on info files. 1999-01-13 23:02:38 +00:00
Fred Drake e36e4e6778 Use \refmodule when we say "use the XXX module instead". 
For the whatsound module, point to sndhdr.
 1999-01-13 17:11:52 +00:00
Fred Drake da94374a86 \seemodule: Fix so that each \seemodule entry gets its own paragraph, 
so they don't get run together when there's no blank line
	between them in the source.  The HTML conversion already did
	the right thing.

\refmodule:  Refer to a module, using a hyperlink in the PDF version.
	Visually the same as \module.
 1999-01-13 17:09:06 +00:00
Fred Drake 2581704dfa do_cmd_refmodule(): New function to support new \refmodule macro. 1999-01-13 17:06:34 +00:00
Fred Drake 8d43a2937b Added a few items. 1999-01-12 21:31:16 +00:00
Fred Drake fcb7adb6aa Fix the HTML tarball target to generate the HTML if needed instead of 
bombing.
 1999-01-12 20:32:39 +00:00
Fred Drake dd7610cac9 Bump the date. Seems like fun. ;-) 1999-01-12 19:51:03 +00:00
Fred Drake 701f10fbea Simplify command that extracts the number of pages from a PostScript 
file; use "grep -c" instead of "grep | wc -l | cut ... | tr ...".
 1999-01-12 19:28:41 +00:00
Fred Drake 39cddb7439 Added \modulesynopsis. 1999-01-12 19:22:11 +00:00
Fred Drake 03dd3efd5a <writer>.send_paragraph(): Clarify what needs to be done by this 
method and what it should not do.  (Specifically: handling
	breaking of last line of preceeding paragraph.)
 1999-01-12 18:33:47 +00:00
Fred Drake 5a0ca4e55c do_cmd_methodline(): Fixed reference to method name when generating 
the output HTML.
 1999-01-12 04:16:51 +00:00
Fred Drake 4856d01797 Removed a lot of unnecessary comment markers which cause unexplained 
numbers to appear in the HTML version of the manual.
 1999-01-12 04:15:20 +00:00
Fred Drake 8e2c9457a2 output_body(): For <address> elements, just skip, since they're 
always part of the page trailer.
 1999-01-11 22:30:34 +00:00
Fred Drake bb3b0028ba Patches describing the statvfs() and fstatvfs() functions. Additional 
text about large file support.

All new text by Steve Clift <clift@mail.anacapa.net>, with only minor
revision / addition of markup.
 1999-01-11 18:36:23 +00:00
Fred Drake b6584cac1e Remove the "lib-" prefix from the name of the info archive. 1999-01-08 15:49:45 +00:00
Fred Drake ed94dde4b9 No longer useful. 1999-01-08 15:48:47 +00:00
Fred Drake dd21c32169 It's finally gone! 1999-01-08 15:40:16 +00:00
Fred Drake f2b5374ba1 Remove obsolete files. 1999-01-08 15:34:06 +00:00
Fred Drake 78104a9b77 Replace most everything but the comment at the top. 1999-01-08 15:33:38 +00:00
Fred Drake c4e9263010 Add a few comments. 1999-01-08 15:32:27 +00:00
Fred Drake c58f346374 New support scripts for HTML->info conversion that use Michael Ernst's new 
conversion tools.
 1999-01-08 15:27:17 +00:00
Fred Drake 3fe1d32693 New conversion tools for HTML->info from Michael Ernst 
<mernst@cs.washington.edu>.

Thanks!
 1999-01-08 15:25:29 +00:00
Fred Drake 637ad47e61 convert(): Make sure no line has trailing whitespace. (docfixer.py 
checks for \n\n as a paragraph separator, LaTeX allows white
	space between the newlines.)
 1999-01-07 18:47:07 +00:00
Fred Drake c7dd3e11da Markup nit. 
Add module synopsis.
 1999-01-07 15:45:55 +00:00
Guido van Rossum cf3ce92ef4 Explain how come that pickle and cPickle, while using the same data 
format, can produce different pickle strings for the same object.
 1999-01-06 23:34:39 +00:00
Guido van Rossum e51aa5b2cd Minor clarifications by Sean Reifschneider: 
- add example of string literal concatenation
- add clarifying comment to the example of the if statement
 1999-01-06 23:14:14 +00:00
Guido van Rossum 87e611e441 Replace the docs for reduce with an adaptation of its docstring, which 
was actually clearer!
 1999-01-06 23:10:51 +00:00
Guido van Rossum 74429eacb5 Add doc for access() and ttyname(). Patch by Sean Reifschneider. 1999-01-06 23:03:43 +00:00
Fred Drake fcc5910090 Preliminary code to mark paragraphs. Seems to work, but very slow. 1999-01-06 22:50:52 +00:00
Fred Drake c553358c63 Remove documentation for whatraw() since it's gone now. 1999-01-06 15:21:19 +00:00
Fred Drake 60adb362df Document the sndhdr module. 
Document that the whatsound module is obsolete.
 1999-01-05 23:09:12 +00:00
Fred Drake a2e4017394 Shorten the synopsis that gets into the table of contents. 1999-01-05 22:54:49 +00:00
Fred Drake ccc627200a write_idxfile(): New function. Isolate format of the external index 
data file used by buildindex.py.

next_argument_id():  Removed; no longer used.

next_argument():  Doesn't use next_argument_id(), just does the work.

gen_target(), gen_target_name():  Removed, no longer used.  The only
	place that used them now does the (trivial) work directly.


Lots of little changes so we never have to pass around $br_id values
all over the place.  The only places they're used now new IDs are
generated as needed.
 1999-01-05 22:16:29 +00:00
Fred Drake 02e18b4b84 Added missing "from" in IOError description. 1999-01-05 21:42:18 +00:00
Fred Drake 26f0f65653 Remove obsolete comment. 1999-01-05 20:53:43 +00:00
Fred Drake 5d56d3665f Make the documents that have indexes dependent on the buildindex.py 
script.
 1999-01-05 15:49:39 +00:00
Fred Drake 7d45f6dcc4 do_cmd_methodline(): New function, implements indexing version of 
\methodline.

Fixed up support for \withsubitem, hopefully improving the fidelity of
the index a bit.
 1999-01-05 14:39:27 +00:00
Fred Drake 3b07480a17 trim_ignored_letters(): Simplify a little. 1999-01-04 22:00:56 +00:00
Fred Drake 8d7e11a8c1 Update information on the version of latex2html to use, including 
complaint about 98.2b8 problems.
 1999-01-04 18:25:38 +00:00
Fred Drake b75d021081 Typo: "TWELV" --> "TWELVE" 
Added note at top, since LaTeX style writers like to force name
changes when someone else makes a change to the style.  I'm sending a
note to the author reporting the error and asking for an updated
version.

This cannot be distributed in this form.  This will be resolved when I
get a response from Ulf Lindgren.

Typo reported by rwolff@noao.edu (Richard Wolff).
 1999-01-04 16:15:02 +00:00
Andrew M. Kuchling f07c328c07 Document the optional mode argument (Z_FLUSH, Z_SYNC_FLUSH, etc.) 
to the flush() method of compressor objects.
 1998-12-31 21:14:23 +00:00
Fred Drake 94c4a7976f Added index entries to make it easier to locate directory & file operations. 1998-12-28 21:58:57 +00:00
Fred Drake 8692998018 Added index entries to make it easier to locate directory operations. 1998-12-28 21:58:15 +00:00
Fred Drake cc09e8dc82 Clarified what Python versions the interactivity chapter applies to, 
and what it doesn't apply to.
 1998-12-28 21:21:36 +00:00
Fred Drake 76fa3b73d6 Remove recently documented modules from the undoc list. 1998-12-28 20:53:19 +00:00
Fred Drake 03a0235793 Print a line to the console reporting the number of index nodes 
processed.  This can be interesting to see.
 1998-12-28 20:46:53 +00:00
Fred Drake 566c8327f7 Added entry for libshutil.tex. 1998-12-28 20:17:33 +00:00
Fred Drake 449e18f459 Add documentation for shutil module. 1998-12-28 20:16:58 +00:00
Fred Drake cd058539a8 Adjust a few niggles that affected the HTML conversion (a couple of 
"^"s were being dropped in the context of [^...]).
 1998-12-28 19:03:24 +00:00
Fred Drake d82af0b8ec Remove all use of $* in commands; some makes (Solaris 2.5, IRIX 6.X) 
only expand this in dependency lists.  Thanks for Sjoerd Mullendar for
pointing this out.
 1998-12-28 15:17:22 +00:00
Guido van Rossum d358afeec0 Document 'N' format character for Py_BuildValue -- like 'O' but doesn't INCREF. 1998-12-23 05:02:08 +00:00
Fred Drake 32f7ae0066 Fix many of the specific targets in links from the index. 
In a number of places, I called next_argument() instead of
next_argument_id() when the ID was also needed.  (7 places)
 1998-12-22 23:41:07 +00:00
Fred Drake 7d65d388b8 Add the getpass module to $(LIBFILES). 1998-12-22 23:38:11 +00:00
Fred Drake 99e2c39b31 Add the getpass module. 1998-12-22 23:37:46 +00:00
Fred Drake 5ac2a07fca Basic documentation for the getpass module. 1998-12-22 23:37:21 +00:00
Fred Drake 85220410e0 Bump $(RELEASE). 1998-12-22 22:17:41 +00:00
Fred Drake 5cb48a4c98 Added a \versionchanged since the API changed to support 
namespaces with 1.5.2.

Added an index entry.

Fixed XML expansion:  XML is the "Extensible Markup Language", not the
"eXtended Markup Language".
 1998-12-22 18:46:13 +00:00
Fred Drake 292b9ebfba Added information on when this was added, allowing us to release the 
documentation on the Web while people are still using < 1.5.2b1.
 1998-12-22 18:40:50 +00:00
Fred Drake ae48aabb10 Update the date. 1998-12-22 18:27:22 +00:00
Fred Drake 1189fa98eb Adjust markup to match current conventions, and make it formattable. 1998-12-22 18:24:13 +00:00