58177b9975
added description of NL token
2001-02-28 22:05:41 +00:00
969ab2710a
Update documentation for termios module; do not refer to the TERMIOS module
...
for constant definitions.
Add a deprecation to the TERMIOS module.
2001-02-27 22:01:15 +00:00
5e1633365d
Patch #403985 : Add support for weak-keyed dictionaries
2001-02-27 18:36:56 +00:00
6397c7c9a9
inspect: a module for getting information out of live Python objects
2001-02-27 14:43:21 +00:00
d4614e8371
Updates to the semantics of function and method attributes.
2001-02-27 03:32:35 +00:00
07e6c505ad
Minor adjustments, including markup corrections.
2001-02-23 19:15:56 +00:00
447f545322
Fix extra backslash in example.
2001-02-23 19:13:07 +00:00
afdc8fc0ad
Fix up the markup in some recently-added portions of the text.
2001-02-23 19:10:41 +00:00
19f3c52347
Work around the broken formatting of sys.ps1 prompts in running text.
...
Move sample sessions to the left margin of the file for consistency;
formatting can adjust the margin if needed.
This closes SF bug #133213 .
2001-02-22 23:15:05 +00:00
7c30de65f4
Remove documentation for the soundex module; the module is no longer
...
included with Python.
2001-02-22 21:25:20 +00:00
7edbd4ffb4
Patch #103885 : Add dynamic registration and lookup of DOM implementations.
2001-02-22 14:05:50 +00:00
754ba589b7
Improve accuracy. In the .tex file, note the new "% BUG:" comments: an
...
extra backslash is getting displayed in the generated HTML.
2001-02-20 11:24:35 +00:00
f0768c822b
Added missing \item. See also bug 133213, about damaged HTML generated
...
for \code(">>>"); don't know how to fix that one.
2001-02-20 10:57:30 +00:00
e79af273e8
Flesh out PlaySound() docs enough so that SND_ALIAS isn't hopelessly confusing.
...
If someone knows how to turn the new table of guaranteed-registered system
sounds into a LaTeX table, be my guest.
2001-02-20 10:02:21 +00:00
5b0705d266
ConfigParser.optionxform(): Document this since it is available for
...
sub-classes and application code to override.
2001-02-19 22:37:24 +00:00
15bc404ca8
Added entries for difflib documentation.
2001-02-19 16:32:40 +00:00
baf71422b8
Documentation for the difflib module, converted from the module docstrings.
2001-02-19 16:31:02 +00:00
373d151666
More typos. libwinsound.tex typo noted by Peter Funk (thanks!).
2001-02-19 08:36:41 +00:00
25a9ce371c
Take a tour of hell's seedier neighborhoods to try to make winsound.Beep()
...
do something non-useless on Win9X boxes. WinME unknown to me. Someone with
NT/2000 make sure it still works there!
2001-02-19 07:06:36 +00:00
c4089d84d8
In the example showing the irrelevance of start columns, restore that the
...
start columns differ (editing had pushed them all into column 0).
2001-02-17 18:03:25 +00:00
f3262b72ca
Add entries for the doctest documentation.
2001-02-17 17:33:25 +00:00
7eb1463bb3
Make a variety of minor markup adjustments.
...
Close some environments so that this will actually format.
2001-02-17 17:32:41 +00:00
7688229f7c
SF patch #103808 : doctest.py docs
...
Checking in Moshe's patch after rewrapping some paragraphs (to consume
fewer columns) and repairing that I/2.**J lost the I.
2001-02-17 05:58:44 +00:00
04f1d37471
mention the use of the maxtries attribute of FancyURLopener in bounding
...
redirection recursion.
2001-02-15 17:00:40 +00:00
bf416fa0dd
Document default blocksize for storbinary().
2001-02-15 13:53:40 +00:00
523ec5709b
Make some clarifications and corrections based on comments from Guido.
...
Fix a few markup nits.
Work around a LaTeX2HTML nuisance.
2001-02-15 05:37:51 +00:00
15862f50e5
Add a note to Node.isSameNode() that it is based on the DOM Level 3 working
...
draft. I'm not sure that's important, but Uche thinks it is.
2001-02-14 20:39:15 +00:00
1d8ad2b1de
Updated to reflect the additional information and interfaces exported in
...
pyexpat.c revision 2.40.
2001-02-14 18:54:32 +00:00
162c6a637a
Reflect change in traceback format:
...
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
e7d7e6c879
Fix two typos
2001-02-14 02:39:11 +00:00
5ed1dac4c0
Update documentation for pyexpat (xml.parsers.expat), to reflect the new
...
support for Expat 1.95.*.
2001-02-08 15:40:33 +00:00
cf2636696d
Fix markup typo in a {verbatim} environment (there should not be any!);
...
caught by Eric Raymond.
2001-02-03 14:35:38 +00:00
40e43bfaf7
Document Node.isSameNode().
2001-02-03 01:20:01 +00:00
f891404e1a
Move the whrandom section back to the documented modules section; this
...
gives people a chance to see the depracation notice.
2001-02-03 01:17:41 +00:00
269625f67a
Revise the deprecation note for the whrandom module to be correct and a
...
little more formal.
2001-02-03 01:12:44 +00:00
6270031f4e
Adjustments to the text of the UnixMailbox description. Added
...
PortableUnixMailbox as a separate class as well (this also generates
the right index entry).
2001-02-02 03:51:05 +00:00
57d943ad38
Move the whrandom entry to the "Obsolete Modules" appendix.
2001-02-02 02:45:08 +00:00
844bd5b4a9
Minor markup adjustments.
2001-02-02 02:42:31 +00:00
68b6417c5a
Added a warning at the top saying that user code should not use the
...
whrandom module directly.
2001-02-02 02:41:17 +00:00
d0946da701
Fix some markup breakage that prevented formatting; re-wrapped a couple of
...
wide paragraphs.
2001-02-01 15:53:24 +00:00
36154b2dbf
Added entry for weakref documentation.
...
Moved commented-out entries for obsolete module to an appendix, still
commented out.
2001-02-01 05:21:46 +00:00
ebcf6a8573
Documentation for the weakref module.
2001-02-01 05:20:20 +00:00
0de88fc4b1
Change random.seed() so that it can get at the full range of possible
...
internal states. Put the old .seed() (which could only get at about
the square root of the # of possibilities) under the new name .whseed(),
for bit-level compatibility with older versions. This occurred to me
while reviewing effbot's book (he found himself stumbling over .seed()
more than once there ...).
2001-02-01 04:59:18 +00:00
30dbd1429a
Document the two changes to the mailbox.py module:
...
- All constructors grow an optional argument `factory' which is a
callable used when new message instances are created by the next()
methods. Defaults to the rfc822.Message class.
- A new subclass of UnixMailbox is added, called PortableUnixMailbox.
It's identical to UnixMailbox, but uses a more portable test for
From_ delimiter lines. With PortableUnixMailbox, any line that
starts with "From " is considered a delimiter (this should really
check for two newlines before the F, but it doesn't.
2001-01-31 22:14:01 +00:00
b416290d5d
Some rewriting of the "Internationalizing your programs and modules"
...
subsection to include a discussion of the msgfmt.py program.
2001-01-31 21:21:45 +00:00
3229b859fb
More on noutrefresh() and scroll().
2001-01-29 06:39:33 +00:00
4fda21ba6b
updated to document use of sequences of two-element tuples as inputs
2001-01-28 21:18:16 +00:00
c37f5b3296
Adjust documentation for new.instance() to reflect that the second
...
parameter may be omitted or None.
2001-01-28 17:23:05 +00:00
9ca35ec97a
Instructive example for strftime(); how to generate RFC822 dates.
2001-01-28 00:56:54 +00:00
e7213c7a80
Emphasis that instantiating this class doesn't consume the message body.
...
Fix some unclear language in the description of the addrlist member.
2001-01-27 10:56:14 +00:00
66f98b45cd
Fix a number of typos found by Guido.
2001-01-26 20:51:32 +00:00
8c071d4388
Massively improved documentation for string formatting operations,
...
primarily from Evelyn Mitchell (thanks!).
This closes SF patch #103412 .
2001-01-26 20:48:35 +00:00
e360d9507a
The combo of getstate/setstate/jumpahead is very powerful, but needs
...
examples to flesh it out for the uninitiated. Here they are.
2001-01-26 10:00:39 +00:00
29052482d1
Removed references to Python 1.5.3; that was a "tentative" number I used
...
in the docs to indicate the next version before we decided on 1.6.
Adjusted winsound.Beep() description slightly as well.
2001-01-25 17:29:18 +00:00
517ce23183
Clarify winsound.beep docs, in response to c.l.py beep brouhahalet.
2001-01-25 09:33:48 +00:00
d52269bfd0
Fix bugs introduced by rewrite (in particular, time-based initialization
...
got broken). Also added new method .jumpahead(N). This finally gives us
a semi-decent answer to how Python's RNGs can be used safely and efficiently
in multithreaded programs (although it requires the user to use the new
machinery!).
2001-01-25 06:23:18 +00:00
d7b5e88e8e
Reworked random.py so that it no longer depends on, and offers all the
...
functionality of, whrandom.py. Also closes all the "XXX" todos in
random.py. New frequently-requested functions/methods getstate() and
setstate(). All exported functions are now bound methods of a hidden
instance. Killed all unintended exports. Updated the docs.
FRED: The more I fiddle the docs, the less I understand the exact
intended use of the \var, \code, \method tags. Please review critically.
GUIDO: See email. I updated NEWS as if whrandom were deprecated; I
think it should be.
2001-01-25 03:36:26 +00:00
83125775e0
A \begin{funcdesc} was closed with an \end{methoddesc}.
2001-01-25 00:39:16 +00:00
21f37e1b88
Fixed a bug where \& was needed.
2001-01-25 00:38:15 +00:00
8ee1a4bdeb
Provide a much better (and complete!) description of the lockf()
...
function, based on an eyeballing of the code.
2001-01-25 00:36:54 +00:00
902446a28d
Supply long-missing docs for random.seed(). Extensive rewrite of module
...
intro docs.
*************** Fred: check my LaTeX! Also, the docs for whrandom should
*************** be moved into Obsolete Modules.
2001-01-24 23:06:53 +00:00
9368a12011
Fix an obvious usage nit I should have caught myself on the previous
...
change to this file. Thanks, /F!
2001-01-24 18:19:40 +00:00
fa004ad36c
Show '\011', '\012', and '\015' as '\t', '\n', '\r' in strings.
...
Switch from octal escapes to hex escapes for other nonprintable characters.
2001-01-24 17:19:08 +00:00
b1b6a11b28
AttributeList --> NamedNodeMap
...
Since there is no such thing as an AttributeList, don't say "attributes"
is one.
2001-01-24 16:17:15 +00:00
0110d3b2ad
new unicodedata functions (name, lookup)
2001-01-24 08:10:07 +00:00
eda28445c0
documented (new) optional doseq parameter to urlencode.
2001-01-24 06:36:06 +00:00
f79cb2db3e
Expose the autoraise capability. Improve the documentation.
2001-01-23 13:49:44 +00:00
aeb5532ca0
Oops...finish a mangled sentence.
2001-01-23 13:22:28 +00:00
f7f185116a
Rewrite webbrowser.py to fix various bugs following Ka-Ping Yee's
...
complaints. The new version moves most of its initialization to
package load time; it's simpler, faster, smaller, and adds support for
Mozilla and Links. Interpretation of the BROWSER variable now works
and is documented. The open_new entry point and methods are marked
"deprecated; may be removed in 2.1".
2001-01-23 13:16:32 +00:00
dc40ac0fe0
Added link to the "Python Codecs" project at SourceForge.
...
Changed markup of the list of values for the list of meaningful "errors"
values.
2001-01-22 20:17:54 +00:00
0f564eaceb
Change some wording to make this work with PDF generation -- using a PDF
...
hyperlink at the start of the paragraph confused pdflatex; it saw the
link start while still in vertical mode, which is not allowed. Including
text before the link forces horizontal mode.
2001-01-22 19:06:20 +00:00
5f0decf0d3
Clean up the docs for the "random" module according to comments from Tim
...
Peters.
This closes SF bug #125919 .
2001-01-22 18:18:30 +00:00
ef8cd7ca99
Minor markup adjustment.
2001-01-22 17:42:32 +00:00
fe385251f4
Make the 'time' argument to the timemodule functions strftime, asctime,
...
ctime, gmtime and localtime optional, defaulting to 'the current time' in
all cases. Adjust docs, add news item. Also convert all argument-handling to
METH_VARARGS. Closes SF patch #103265 .
2001-01-19 23:16:56 +00:00
6f77667a64
Backed out the unistr() builtin.
2001-01-19 21:36:19 +00:00
bc0b260a77
Minor markup cleaning, and one required fix in the unistr() description.
2001-01-18 18:09:07 +00:00
9483bed6d9
correct typo - closes bug #129205
2001-01-18 10:44:08 +00:00
3a9582fbe5
Fix the example (it didn't seem to reflect reality).
2001-01-18 07:50:17 +00:00
ad7c98e264
This patch adds a new builtin unistr() which behaves like str()
...
except that it always returns Unicode objects.
A new C API PyObject_Unicode() is also provided.
This closes patch #101664 .
Written by Marc-Andre Lemburg. Copyright assigned to Guido van Rossum.
2001-01-17 17:09:53 +00:00
90badd1286
Add a missing newline in an example; caught by Chris Ryland
...
<cpr@emsoftware.com>.
2001-01-17 05:12:13 +00:00
20ab9e9c0a
Document xreadlines() method. (Forgot to check this in before!)
2001-01-17 01:18:00 +00:00
25be1931a0
Fix a few small markup/consistency nits.
2001-01-16 20:52:41 +00:00
bd1a489759
push_source() and pop_source() entry points for shlex instances.
...
These basically just make available to the user what userhook()
does to the source stack. Documentation included.
2001-01-16 14:18:55 +00:00
83ad5015cb
effbot caught a typo!
2001-01-15 20:51:40 +00:00
773d9f09be
Document function attributes for both the function type and the method
...
type. The method documentation also includes a new brief discussion
of `bound' vs. `unbound' and why setting an attr on a bound method is
a TypeError. Includes Skip's suggested text.
2001-01-15 20:28:50 +00:00
a770e866d6
Fixing author's email address.
2001-01-15 17:08:45 +00:00
97d3b93c2f
Document changed default to passive mode.
2001-01-15 16:37:05 +00:00
77b20f099e
Document filterwarnings(..., append=<bool>).
2001-01-14 14:10:18 +00:00
1beb3d204f
Added note that this module was added in Python 2.1.
2001-01-12 22:57:32 +00:00
ca7e1ee01a
Updated descriptions to incorporate additional information from Tim Peters.
...
This mostly closes SF bug #128251 .
2001-01-11 22:49:49 +00:00
a177c40daf
Document \code{import} in pth files.
2001-01-11 22:07:25 +00:00
49c9ac30a4
Fixed minor markup nits for consistency with the rest of the library
...
reference.
2001-01-11 16:02:08 +00:00
ab78beca2f
Added pointer on POP3 variations.
2001-01-11 10:22:34 +00:00
f68f2fec7d
Implementation of PEP-0217.
...
This closes the PEP, and patch 103170
2001-01-11 05:41:27 +00:00
5ac97957f7
Corrections and additions to the documentation for POP3 and IMAP library
...
support, based on my fetchmail experience.
2001-01-11 04:19:52 +00:00
8321026ff4
SourceForge patch #103140 , checked in at fdrake's invitation. Minor fixes and
...
additions to library docs.#
2001-01-10 19:34:52 +00:00
3c48ef7de8
Added documentation for the xreadlines module & related changes. The
...
documentation was written by Jeff Epler (thanks!).
2001-01-09 22:47:46 +00:00
986eafdc2b
Added missing word; fixed minor nits.
2001-01-09 20:54:15 +00:00
37f1b34b62
Added entry for fpectl module documentation.
...
Moved the mutex docs to be adjacent to the sched docs, since these are
meant to be used together (if they are used at all!).
2001-01-09 20:52:49 +00:00
a5e7ad99d5
Documentation for the fpectl module, from Lee Busby. (Thanks!)
2001-01-09 20:38:54 +00:00
45b1d6a831
Explain that long options are matched based on a unique prefix rather than
...
requiring the whole option to be typed out.
This closes SF bug #126863 .
2001-01-08 16:05:51 +00:00
e1d4715a6f
Update explanation of the set_location() method to indicate that in
...
BTree databases, the key need not be in the database. Also, tell about
the exception if the key is not in the DB for other DB types.
This closes SF bug #127377 .
2001-01-05 06:44:19 +00:00
4e18f07613
Based on comments from Guido, do not describe bisect() and insert() as
...
being "for backward compatibility." Also revert to using bisect() in the
example, since Guido thinks that is the best recommendation for typical
usage.
2001-01-04 14:18:55 +00:00
288927f426
Markup nit: Command line options should be marked with \programopt.
...
Other minor markup nits fixed.
Make reference to PyErr_Warn() a hyperlink.
2001-01-04 05:59:37 +00:00
b162d188f6
Fix typo spotted by Detlef Lannert <lannert@users.sourceforge.net>.
2001-01-04 05:48:08 +00:00
19ae78302e
Added information about the interaction of opening a file in append mode
...
and seek() in the description of seek().
This closes SF bug #126850 .
2001-01-04 05:16:39 +00:00
22e9a5eaec
Markup nit: OK and ERR should be marked \constant in running text.
2001-01-04 05:14:45 +00:00
2a72712efe
Update documentation to include the new functions, and use the more
...
explicitly-named bisect_right() in the example code.
This closes SF bug #127055 .
2001-01-04 05:12:52 +00:00
9c15fa7a0f
Description of long(): A string parameter is no longer required to be
...
*decimal*.
This closes SF bug #127273 .
2001-01-04 05:09:16 +00:00
be0630282e
Fix doubled word
2000-12-26 16:14:32 +00:00
8694cc42ab
Remove redundant reference to tab (since it = 'horizontal tab')
2000-12-26 16:09:37 +00:00
e6bf85845f
Document ERR and OK
2000-12-26 15:58:27 +00:00
1dea760ca1
Make sure subsections are formatted into HTML pages with reasonable names.
2000-12-25 06:19:08 +00:00
f08cbb1771
Added information on the ExternalEntityParserCreate() method.
2000-12-23 22:19:05 +00:00
5caee408b8
Add 'see also' link to curses.panel
2000-12-22 22:06:43 +00:00
676634beda
Added documentation for the panel wrapper module
2000-12-22 21:57:42 +00:00
e412e7a3a0
Fix lots of small markup nits.
...
Wrapped some long lines.
2000-12-21 17:04:31 +00:00
68a6f5a0a2
Document the window.overlay() and .overwrite() methods
2000-12-21 16:25:44 +00:00
5db5ba1ee3
Document the warnings module.
2000-12-19 06:01:23 +00:00
1367b83797
Document warning categories.
2000-12-19 04:27:54 +00:00
5b56765fe7
Added documentation on the ErrorHandler interface.
...
This closes bug #126034 .
2000-12-19 04:07:54 +00:00
2b6d7bc151
Do not talk about "real" numbers; talk about "floats" or "floating point
...
numbers" instead; we have not described "reals" anywhere else in the
documentation, and this is not the place to change the story!
Reported by Keith Briggs <keith.briggs@bt.com>.
2000-12-18 13:50:24 +00:00
e9e860faf3
Add support for gdbm2 open flags ('s' and 'u'). Add module constant
...
open_flags which contains the flags supported by gdbm. Closes patch
#102802 .
2000-12-17 07:14:13 +00:00
5100133685
urlretrieve() description included explanation of "data" parameter, but
...
did not include it in the signature.
Fixed some markup nits.
2000-12-15 23:57:51 +00:00
065cba1281
Added documentation for random.shuffle().
2000-12-15 19:07:17 +00:00
29c45a5e91
Grant Griffin <grant.griffin@honeywell.com>:
...
Clarify that invert() is a *bitwise* operation.
2000-12-15 05:41:49 +00:00
4fb588240f
Document napms()
...
Add reference to demo directory
2000-12-15 01:03:23 +00:00
f0b315478b
Update information on the locking() function, added the needed constants.
...
(Thanks for the info, Tim!)
2000-12-14 03:11:24 +00:00
48971198c5
Finish a sentence that was left half-written!
2000-12-13 22:36:02 +00:00
dd802208a7
Changing allow_reuse_address's default value, and documenting it.
2000-12-13 20:39:22 +00:00
24d6da3eae
Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
...
useful explanations.
2000-12-13 19:34:38 +00:00
bc9c1b15cc
Added descriptions of the defined exceptions and their mapping to the
...
DOM recommendation.
2000-12-13 17:38:02 +00:00
ff63f2023d
"Documentation" for {}.popitem().
2000-12-12 22:03:47 +00:00
ed911b8cfb
Added link to HTML version of the NumPy documentation.
...
This closes bug #124943 .
2000-12-11 20:57:13 +00:00
5255c791cc
select.select(): Add note that though this function accepts empty lists,
...
using *only* empty lists may not be acceptable on all
platforms, with the specific caveat that it does not
work on Windows. Also clarified list of acceptable
objects that may be in the lists, to let the user know
that file objects are not usable here on Windows.
2000-12-11 15:50:07 +00:00
9a29dd6580
Lots of small improvements and bits of added information on the DOM API.
2000-12-08 06:54:51 +00:00
16942f2224
Lots of additional information. Not done, but much better.
2000-12-07 04:47:51 +00:00
fd4d29cf5d
Typo caught by Jim Tittsler <jwt@onjapan.net>: They --> The
2000-12-07 00:03:24 +00:00
b62966c175
Note that, as of Python 1.6, the .returns_unicode attribute on parser
...
objects can be modified at any point with the expected results.
2000-12-07 00:00:21 +00:00
b6a54d2a2c
_getframe(): New sys module function for getting at the stack frame.
...
Implements and closes SF patch #102106 , with Guido's suggested
documentation changes.
2000-12-06 21:47:46 +00:00
21e4dd0492
Two typos caught by /F; thanks!
2000-12-04 22:29:17 +00:00
e119c8fc61
Added a comment for ContentHandler.characters() explaining how to migrate
...
SAX1 code to SAX2, based on bug #123695 .
2000-12-04 22:04:15 +00:00
57657bce94
Update Moshe Zadka's email address to one works and might last a while.
2000-12-01 15:25:23 +00:00
5725d1eb03
Backing out my changes.
...
Improved version coming soon to a Source Forge near you!
2000-11-30 19:30:21 +00:00
1a62750eda
Added .first{item,value,key}() to dictionaries.
...
Complete with docos and tests.
OKed by Guido.
2000-11-30 12:31:03 +00:00
c01f6e691b
Use a table to describe the keys to the locale information dictionary;
...
this is slightly easier to read than the list environment that had been
used.
2000-11-30 07:13:58 +00:00
e0b9deb3ce
Use small tables instead of bare \item markers to describe the contents
...
of return tuples. The bare \item took advantage of an implementation
detail when formatting in LaTeX, and was just wrong when generating HTML.
It also broke the XML conversion scripts, since there was no enclosing
list-like environment to contain them.
2000-11-30 07:12:54 +00:00
f65ab1bf10
Added entries reflecting the separation of the abstract DOM documentation
...
and the implementation docs for xml.dom.minidom.
2000-11-29 06:11:29 +00:00
eaf57aa44a
Substantial re-organization of the DOM documentation. The abstract API
...
is now separated from the supplied standard implementation. Not all
interfaces are documented yet, but the structure is better set up to do
so.
There is still a lot to do here, but the shape of the documentation is
coming into line.
2000-11-29 06:10:22 +00:00
83ff4af1a3
Added information on the use of Unicode with the StringIO and cStringIO
...
modules, otherwise the behavior is just plain confusing.
2000-11-28 16:24:28 +00:00
Skip Montanaro
Fred Drake
Martin v. Löwis
Ka-Ping Yee
Barry Warsaw
Tim Peters
Guido van Rossum
Andrew M. Kuchling
Eric S. Raymond
Fredrik Lundh
Thomas Wouters
Marc-André Lemburg
Moshe Zadka
Neil Schemenauer