Commit Graph

1382 Commits

Author SHA1 Message Date
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