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
12ed36525a Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>
(re-written).
2000-04-04 20:43:50 +00:00
Fred Drake
005f494a7f Added "See also" section; from Peter Funk <pf@artcom-gmbh.de>. 2000-04-04 20:42:38 +00:00
Fred Drake
7d68690d8d Added notes about the eventual disappearance of two-parameter bind(),
connect(), and connect_ex().

I didn't make these deprecation notices since it was never a
documented feature.
2000-04-04 17:48:30 +00:00
Fred Drake
38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake
6a0d844e76 UserString section:
Small cleanups noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.

Make the spelling of Unicode always uppercase.
2000-04-03 15:02:35 +00:00
Fred Drake
a22b576d05 UserString class from Peter Funk <pf@artcom-gmbh.de>. 2000-04-03 03:51:50 +00:00
Fred Drake
3c9f936eee Two new sections. Preliminary. 2000-03-31 17:51:10 +00:00
Fred Drake
15861b2a41 Update portability information for the spawn*() functions and related
constants.  Someone will need to fill in information on the spawn*()
functions that aren't listed.
2000-02-29 05:19:38 +00:00
Fred Drake
0baf773c44 Added entry for libtabnanny.tex. 2000-02-23 15:44:58 +00:00
Fred Drake
155348be33 Initial version from Peter Funk <pf@artcom-gmbh.de>, with minor
consistency changes and a note that the API may change in the future.
2000-02-23 15:44:08 +00:00
Fred Drake
1e862e8a37 Update the description of int() to include the radix parameter;
omission noted on c.l.py by Aahz Maruch.

Swapped the order of the descriptions of int() and intern() so that
int() comes first (the functions are in alphabetic order).
2000-02-17 17:45:52 +00:00
Guido van Rossum
8006d316bc Added docs for new crc32() function. By Jim Ahlstrom.
(Fred, please check.)
2000-02-16 21:13:37 +00:00
Barry Warsaw
41d84631ba Document the API changes to the nntplib module (exceptions become
classes, NNTP.__init__() grows a new optional argument to set reader
mode on the server).
2000-02-10 20:26:45 +00:00
Fred Drake
2bb43a20ce The dircmp module is now obsolete. 2000-02-03 15:27:26 +00:00
Fred Drake
76e6da38c0 Document GetoptError and label error an alias. 1999-12-21 22:50:05 +00:00
Fred Drake
b9bdfc6a23 Document 1.5.2+ aspects of the NotANumber exception. (Note that this
is in the development branch, not the maintenance branch!)
1999-12-21 18:45:16 +00:00
Fred Drake
89ab163479 Document that the |mode| parameter to open() is optional and explain how
the default value is determined.
1999-12-21 18:31:30 +00:00
Fred Drake
88f6ca2ce9 Document getgroups(), getlogin(), fpathconf(), pathconf(),
pathconf_names, confstr(), confstr_names, sysconf(), sysconf_names.
1999-12-15 19:39:04 +00:00
Fred Drake
d16b5abc07 Markup consistency nits that Guido didn't check. ;-) 1999-12-13 23:34:42 +00:00
Guido van Rossum
5f7a28cdf8 Doc update from Piers Lauder see changes for imaplib.py version 2.16. 1999-12-13 23:29:39 +00:00
Fred Drake
18f7a45324 Document the new stuff in the os module. 1999-12-09 22:11:43 +00:00
Fred Drake
d4d4ba3fd2 Update link to PythonWare library page. 1999-12-01 18:44:09 +00:00
Fred Drake
7424242c1c Removed last XXX comment; no further action needed on this one. 1999-11-17 16:09:57 +00:00
Fred Drake
55e93964e6 Preliminary documentation for turtle module (Tk), by Moshe Zadka.
Fixed up a few TeXisms and markup nits, but otherwise unchanged.
Somewhat raw.
1999-11-15 17:03:41 +00:00
Fred Drake
37f1574f2e Use \citetitle and \programopt as appropriate. 1999-11-10 16:21:37 +00:00
Fred Drake
ebe0341109 Use \citetitle instead of \emph. 1999-11-09 20:11:17 +00:00
Fred Drake
356d0ceb7e Use \citetitle in one place. 1999-11-09 20:10:01 +00:00
Fred Drake
268df27c9a Use the new markup as apporpriate. 1999-11-09 19:45:59 +00:00
Fred Drake
6e9ea59a43 Use \programopt in one place. 1999-11-09 19:44:44 +00:00
Fred Drake
d290c10890 Use \programopt in one place. 1999-11-09 18:03:00 +00:00
Fred Drake
6cf186b867 pathes --> paths; typo reported by Gerry Wiener <gerry@ucar.edu>. 1999-10-29 17:51:29 +00:00
Fred Drake
47a27b6640 Make references to new filecmp module hyperlinks now that there's
documentation.
1999-10-29 17:25:59 +00:00
Fred Drake
adf2dbfced Added section for filecmp. 1999-10-29 17:24:12 +00:00
Fred Drake
c7b5b3c998 filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>. 1999-10-29 17:23:15 +00:00
Fred Drake
7eaf6828cb Added deprecation notes, in case anyone decides to read these anyway. 1999-10-26 16:31:51 +00:00
Fred Drake
143db4b041 cmp and cmpcache are now obsolete, so don't include their
documentation sections.
1999-10-26 16:28:04 +00:00
Fred Drake
a8052a3113 Added cmp and cmpcache to the "Obsolete" section. 1999-10-26 16:27:28 +00:00
Fred Drake
714fd26a2f Documented Beep() function. 1999-10-22 21:08:56 +00:00
Fred Drake
39d4a0237a Fixed typo in explanation of abspath(); noticed by Paul Prescod
<paul@prescod.net>.
1999-10-18 14:10:06 +00:00
Fred Drake
933d5a7c6e os.name: Note that 'java' is one of the registered names. 1999-09-17 14:38:39 +00:00
Fred Drake
e6fb1c4bd3 Added documentation for inet_aton() and inet_ntoa(), from Ben
Gertzfield <che@debian.org> (with minor changes).

(Should have been here instead of in the branch in the first place,
since these weren't in for the 1.5.2 release.)
1999-09-16 15:50:00 +00:00
Fred Drake
244ad3ca15 Name the parameter to expr() and suite() "source" instead of "string". 1999-09-09 14:16:36 +00:00
Guido van Rossum
e7f19200e8 Doco update from Sjoerd Mullender. 1999-08-26 15:57:44 +00:00
Fred Drake
b68a125d64 Added additional index entries.
Minor markup nits.
1999-08-24 20:16:29 +00:00
Fred Drake
76dd228f52 whrandom should come immediately after random, not before. 1999-08-23 20:12:11 +00:00
Fred Drake
7eba1d8bbe Tell what the result objects are (based on comment from the list). 1999-08-19 17:00:38 +00:00
Guido van Rossum
b3fc9d148d Added disclaimer to the sleep() function. 1999-08-19 14:42:54 +00:00
Fred Drake
31e5e37196 Explain the possible range of values for the pid parameter to
waitpid().
1999-08-13 13:36:33 +00:00
Fred Drake
68921dfa31 In note mentioning [].remove()'s exception, tell what exception is
raised.  Prompted by Barry's whining.  ;-0
1999-08-09 17:05:12 +00:00
Fred Drake
d3fbdfd007 Add index entries for open():
buffer size, I/O
	I/O control, buffering
	line-buffered I/O
	unbuffered I/O
1999-08-05 13:43:08 +00:00
Fred Drake
8c9fc00f8d Add index entry "I/O control, buffering" for fdopen(). 1999-08-05 13:41:31 +00:00
Fred Drake
a94f6762bc Add index entry "I/O control, buffering" for makefile(). 1999-08-05 13:41:04 +00:00
Guido van Rossum
068bdb181d Change the directory tree walking example to use clearer variable
names, some suggested by Joe Ellsworth.
1999-08-03 21:52:29 +00:00
Fred Drake
c71b802c47 Markup nits.
Adjust examples to use the object interface instead of the function
interface.
1999-08-02 14:30:52 +00:00
Fred Drake
ce201128b0 Fixed hyperlink references to the __builtin__ and __main__ modules;
error reported by Dale Nagata <DNagata@creo.com>.
1999-08-02 14:13:09 +00:00
Fred Drake
8d21243c3e Added description of optional parameter to UserDict constructor.
Omission reported by Barry Warsaw.
1999-07-26 15:45:52 +00:00
Fred Drake
de5d5ce7bc Update getattr() description to document the optional third
parameter.  Thanks to Barry Warsaw for pointing out the oversight.
1999-07-22 19:21:45 +00:00
Fred Drake
5d48e458e4 typo: privide --> provide
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
1999-07-20 13:21:42 +00:00
Fred Drake
6db897c52c Move chdir() and getcwd() descriptions to "Files and Directories" with
a pointer from the "Process Parameters" section.  Based on comments
from Aahz Maruch, Tim Peters, and GvR.
1999-07-12 16:49:30 +00:00
Fred Drake
3a4ceb707d Several methods return tuples, not lists. 1999-07-07 14:04:38 +00:00
Fred Drake
363d67c2e6 Move some misc. comments from the example section to the main section.
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion).  Add a blank line
after the import line for clarity.
1999-07-07 13:42:56 +00:00
Fred Drake
1508970a47 dir() method description revised based on comments from Greg Stein. 1999-07-07 13:36:22 +00:00
Fred Drake
6166b871a2 Missing space; reported by Robert Kern <kernr@ncifcrf.gov>. 1999-07-06 21:00:18 +00:00
Fred Drake
d5dfe984e7 Fix a number of minor problems pointed out by /F. 1999-07-06 15:50:23 +00:00
Fred Drake
0d6e6e0b39 Fixed typo reported by /F; thanks! 1999-07-06 15:43:55 +00:00
Fred Drake
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
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
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
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