0
0
mirror of https://github.com/python/cpython.git synced 2024-11-30 18:51:15 +01:00
Commit Graph

1439 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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
7088df4c56 Removed old comments. 1999-05-13 16:20:30 +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
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
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
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
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
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
5f342ac2a7 Always use "section" when referring to sections of a document, not "Section". 1999-04-29 02:47:40 +00:00
Fred Drake
c0fcbc1ac6 Update starship URLs. 1999-04-29 02:30:04 +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
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
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
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
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
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
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
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
3d815bd1c7 Added link to xdrlib module in "See also" section. 1999-04-21 15:57: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
0ebd5483be Removed dbhash from the undocumented list. 1999-04-15 16:05:29 +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
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
bfb092eb86 Misspellling: "occurance" --> "occurrence" 1999-04-09 19:57:09 +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
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
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
806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +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
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
Guido van Rossum
8be229650d Document new builtin buffer(). Greg Stein. 1999-03-19 19:10:14 +00:00
Fred Drake
596766772e Documented FTP.set_pasv(). 1999-03-18 16:08:54 +00:00
Fred Drake
154d909993 Note that abspath() was added in 1.5.2. 1999-03-17 22:25:11 +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
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
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
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
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
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
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
1ec71cb556 Incorporated updates to describe geturl() by Sjoerd Mullender
<Sjoerd.Mullender@cwi.nl>.
1999-02-22 22:42:14 +00:00
Fred Drake
00a3a65cc0 Refer to the right RFC in the intro. 1999-02-22 17:12:42 +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
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
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
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
951eea4733 atof() description: Add information about accepting 'NaN' to produce
the NaN value.
1999-02-18 03:49:20 +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
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
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
2d2b6a0074 Markup nits. 1999-02-12 20:40:49 +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
26b698fa4d Document <complex #>.conjugate(). 1999-02-12 18:27:31 +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
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
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
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
98be47e737 OSError description: "as the by the" --> "as the" 1999-02-01 16:17:40 +00:00
Guido van Rossum
1804dc3c07 Document abspath() (implementation is forthcoming). 1999-01-29 18:05:05 +00:00
Fred Drake
703b70e260 Added \modulesynopsis. 1999-01-28 19:30:49 +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
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
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
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
7eca8e5017 Fix typo spotted by Jeff MacDonald <jam@ans.net>. 1999-01-18 15:46:02 +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
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
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
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
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
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
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
02e18b4b84 Added missing "from" in IOError description. 1999-01-05 21:42:18 +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