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
Andrew M. Kuchling
d24ff44f06 Document .timeout() method and .typeahead() function 2000-06-21 01:42:51 +00:00
Andrew M. Kuchling
0adfb45b9a Make changes and clarifications suggested by Mark Hammond 2000-06-18 04:17:38 +00:00
Andrew M. Kuchling
b8050697b8 Documentation for the mmap module: proofreaders welcomed 2000-06-17 22:39:05 +00:00
Fred Drake
9e759dfc31 Michael Hudson <mwh21@cam.ac.uk>:
This patch corrects a little glitch and two outright errors.

(Including one reported earlier by Thomas Wouters.)
2000-06-15 18:44:30 +00:00
Fred Drake
fb79ffae4d Hook in the documentation for the unicodedata module. 2000-06-13 20:51:29 +00:00
Fred Drake
28b294459d Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for the unicodedata module (massaged by Fred for minor
consistency issues).
2000-06-13 20:50:50 +00:00
Andrew M. Kuchling
6b14eebae6 Documentation for the pyexpat module. 2000-06-11 02:42:07 +00:00
Fred Drake
d1a65ff40b Added preliminary documentation for the winreg module,
by Mark Hammond <markh@activestate.com>.

Limited markup & consistency revisions by FLD.
2000-06-07 04:07:48 +00:00
Fred Drake
6c16019136 Fixed typo noted by Guido Kollerie <gkoller@cs.vu.nl> in example code. 2000-05-30 14:39:45 +00:00
Fred Drake
b80a777859 Added documentation for gettempprefix().
Deprecated direct access to template.
Added note about past need to modify template so that legacy code has a
better chance of being understood, noting that the requirement to reset
template after os.fork() disappeared in 1.5.2.
2000-05-26 19:32:14 +00:00
Fred Drake
0233075fce Added documentation for TemporaryFile() and the siffix parameter to mktemp().
Removed obsolete comments about this module not creating or removing actual
files.
Removed obsolete comment about users needing to set template to None after
calling os.fork().
2000-05-26 19:05:16 +00:00
Fred Drake
99d707af47 Piers Lauder <piers@cs.su.oz.au>:
I've added an extra comment about quoting arguments to
IMAP4 commands. Also changed the command descriptions
to show optional extra commands where appropriate.

Fred Drake:
Added example usage for the search() method based on comments from
<Lucas.DeJonge@awtpl.com.au>; elaborated error handling information
when arguments are missing from search() and uid().
2000-05-26 04:08:37 +00:00
Andrew M. Kuchling
f1dc5fa2c8 Updated docs to list all the new methods and functions. The docs are
now complete, but probably still not very helpful or friendly.

Note: two very large tables (of key names, and of character names) were
added; these tables format terribly, and need some reworking.
2000-05-23 16:46:04 +00:00
Fred Drake
7cb42cd070 From Greg Ward <gward@python.net>:
Typo:  "dictionairy" --> "dictionary" (twice).
2000-05-23 02:28:26 +00:00
Fred Drake
8c5cedee69 New description for math.frexp() -- poor description noted by
Francois Pinard.
2000-05-18 05:07:38 +00:00
Guido van Rossum
c9a5f343bc The addition of rint() (by Peter Schneider-Kamp; I forgot to mention
that before) in the previous patch has one problem; rint() is not in
the C math library on all platforms (e.g. not for VC++).  Make it
conditional on HAVE_RINT.
2000-05-11 18:42:27 +00:00
Guido van Rossum
71260b846e Added math.rint() -- round according to current IEEE754 mode 2000-05-11 18:19:42 +00:00
Fred Drake
625d70a7a6 Fix references to the built-in compile() that don't include the
filename parameter.  Noted by Randall Hopper <aa8vb@yahoo.com>.
2000-05-09 17:10:23 +00:00
Fred Drake
35784dff6a Skip Montanaro <skip@mojam.com>:
The intent is that this diff adds a link to the rfc822 module doc and
an index reference to this module under the rfc822 heading.

Fred, based on a suggestion from Grant Griffin <grant.griffin@honeywell.com>:
Added link to the MIME FAQ, so people can more easily get more
information about the subject of the module.
2000-05-09 16:23:23 +00:00
Fred Drake
d85f05940e read() method: clarify that strings are accepted and interpreted
reasonably.

readfp() method:  added documentation.
2000-05-09 15:06:32 +00:00
Fred Drake
3d69c0e440 Someone found the examples of poor practice on socket addresses!
Spotted by Greg Kochanski <gpk@bell-labs.com>.
2000-05-03 19:40:32 +00:00
Fred Drake
ae08853fb0 Clarify status of connection of a new instance; it *is* connected if
you pass server information to the constructor.  Error noted by Pedro
Diaz Jimenez <diazjimenez@ctv.es>.
2000-05-03 15:11:47 +00:00
Fred Drake
e06d025e00 Use \versionchanged to indicate when the second parameter to utime()
was allowed to be None.
2000-05-02 17:29:35 +00:00
Guido van Rossum
d67ddbbec1 Eric Raymond:
(1) Added and documented the capability for shlex to handle
lexical-level inclusion and a stack of input sources.  Also, the input
stream member is now documented, and the constructor takes an optional
source-filename.  The class provides facilities to generate error
messages that track file and line number.

(2) Add a convenience function to generate C-compiler style error
leaders.
2000-05-01 20:14:47 +00:00
Barry Warsaw
93a8eacde5 Document the new additional signature for utime(). In addition to the
previous functionality utime(path, (atime, mtime)), now allowed is
utime(path, None) which sets the file's times to the current time.
2000-05-01 16:18:22 +00:00
Fred Drake
40ee7acb95 \file and \filenq should not be used in section titles; they are not
sufficiently robust to survive the creation of bookmarks in the PDF
format.
2000-04-28 18:17:23 +00:00
Fred Drake
ac308d0a6f Added a "See also:" section that exhibits the \seerfc markup. 2000-04-26 18:20:04 +00:00
Fred Drake
cebda6f5f0 Added documentation for WindowsError; omission noted by Michal Bozon
<bozon@natur.cuni.cz>.

(Mark Hammond, other Python/Windows cognoscenti: please check this!)
2000-04-17 17:42:00 +00:00
Fred Drake
9cf7587fdc Update change to version_info structure. 2000-04-13 17:51:58 +00:00
Fred Drake
4d65d73686 Document hexversion (incompletely explained) and version_info (easily
explained).
2000-04-13 16:54:17 +00:00
Fred Drake
ee775a194c Make use of \longprogramopt where appropriate. 2000-04-11 19:46:40 +00:00
Fred Drake
0682be4524 letters:
Fix description; lowercase and uppercase are strings, not
        functions!  Noted by Randall Hopper <aa8vb@yahoo.com>.

maketrans():
        Minor markup nits in description.
2000-04-10 18:35:49 +00:00
Fred Drake
9164f88657 Fix Skip's email address in his attribution! (Thanks, Skip!) 2000-04-08 04:53:29 +00:00
Fred Drake
c2c46c3751 New example from Skip Montanaro <skip@mojam.com>. 2000-04-07 16:09:59 +00:00
Fred Drake
69ca950d1f Make sure the \declaremodule uses the right name for the module!
Clean up several markup problems & inconsistencies.
2000-04-06 16:09:59 +00:00
Fred Drake
343301aaa4 unichr(),
unicode():  Added \versionadded{} annotations.
2000-04-06 15:06:03 +00:00
Fred Drake
0b72116812 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeType.
2000-04-06 15:05:04 +00:00
Fred Drake
56ced2a7e4 Marc-Andre Lemburg <mal@lemburg.com>:
Added note that Unicode strings are picklable.
2000-04-06 15:04:30 +00:00
Fred Drake
5828ad6963 Revised / removed comments about string exceptions (relating to the
standard exceptions), added documentation of UnboundLocalError.
2000-04-06 15:03:01 +00:00
Fred Drake
3cb793e8e8 Marc-Andre Lemburg <mal@lemburg.com>:
Added UnicodeError description.
2000-04-06 14:48:35 +00:00
Fred Drake
61098f201e Marc-Andre Lemburg <mal@lemburg.com>:
Add Unicode strings to the list of marshalable types.
2000-04-06 14:47:20 +00:00
Fred Drake
665dd704a3 Note the exception raised when parameter to chr() is out of range. 2000-04-06 14:45:19 +00:00
Fred Drake
33d51841a3 Marc-Andre Lemburg <mal@lemburg.com>:
Documentation for unichr(), unicode(), update for ord().
2000-04-06 14:43:12 +00:00
Fred Drake
98f8a3d8da Added codecs entry here as part of String Services. 2000-04-06 14:25:28 +00:00
Fred Drake
b7979c756c Marc-Andre Lemburg <mal@lemburg.com>:
codecs module documentation, with some preliminary markup
adjustments from FLD.
2000-04-06 14:21:58 +00:00
Fred Drake
6d5c6bdb25 Removed bogus connect() call in SMTP example; reported by Travis
B. Hartwell <slt5v@cc.usu.edu>.

Removed second copy of the "See also" section!
2000-04-05 22:12:06 +00:00
Fred Drake
71b04dab58 Added reference to the multifile module from the "See also" section
in the mimetools documentation.
Suggested by Skip Montanaro <skip@mojam.com>.
2000-04-05 22:05:15 +00:00
Fred Drake
d1a56f4235 Noted by Guido:
Fixed up descriptions of altzone and timezone not to refer to the
0th meridian, which doesn't exist.  Reference is now to UTC.
2000-04-05 15:06:03 +00:00
Fred Drake
898915d7e2 Noted by Guido:
Directionality of up/down were confused.
2000-04-05 15:01:36 +00:00
Fred Drake
43b89b637f Noted by Guido:
Note in the "Caveats" section should refer to the exit() function, not
exit_thread().
2000-04-05 15:00:38 +00:00
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