Barry Warsaw
d4614e8371
Updates to the semantics of function and method attributes.
2001-02-27 03:32:35 +00:00
Fred Drake
07e6c505ad
Minor adjustments, including markup corrections.
2001-02-23 19:15:56 +00:00
Fred Drake
447f545322
Fix extra backslash in example.
2001-02-23 19:13:07 +00:00
Fred Drake
afdc8fc0ad
Fix up the markup in some recently-added portions of the text.
2001-02-23 19:10:41 +00:00
Fred Drake
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
Fred Drake
7c30de65f4
Remove documentation for the soundex module; the module is no longer
...
included with Python.
2001-02-22 21:25:20 +00:00
Martin v. Löwis
7edbd4ffb4
Patch #103885 : Add dynamic registration and lookup of DOM implementations.
2001-02-22 14:05:50 +00:00
Tim Peters
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
Tim Peters
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
Tim Peters
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
Fred Drake
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
Fred Drake
15bc404ca8
Added entries for difflib documentation.
2001-02-19 16:32:40 +00:00
Fred Drake
baf71422b8
Documentation for the difflib module, converted from the module docstrings.
2001-02-19 16:31:02 +00:00
Tim Peters
373d151666
More typos. libwinsound.tex typo noted by Peter Funk (thanks!).
2001-02-19 08:36:41 +00:00
Tim Peters
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
Tim Peters
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
Fred Drake
f3262b72ca
Add entries for the doctest documentation.
2001-02-17 17:33:25 +00:00
Fred Drake
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
Tim Peters
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
Skip Montanaro
04f1d37471
mention the use of the maxtries attribute of FancyURLopener in bounding
...
redirection recursion.
2001-02-15 17:00:40 +00:00
Guido van Rossum
bf416fa0dd
Document default blocksize for storbinary().
2001-02-15 13:53:40 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
1d8ad2b1de
Updated to reflect the additional information and interfaces exported in
...
pyexpat.c revision 2.40.
2001-02-14 18:54:32 +00:00
Fred Drake
162c6a637a
Reflect change in traceback format:
...
"innermost last" --> "most recent call last"
2001-02-14 03:20:18 +00:00
Andrew M. Kuchling
e7d7e6c879
Fix two typos
2001-02-14 02:39:11 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
40e43bfaf7
Document Node.isSameNode().
2001-02-03 01:20:01 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
57d943ad38
Move the whrandom entry to the "Obsolete Modules" appendix.
2001-02-02 02:45:08 +00:00
Fred Drake
844bd5b4a9
Minor markup adjustments.
2001-02-02 02:42:31 +00:00
Fred Drake
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
Fred Drake
d0946da701
Fix some markup breakage that prevented formatting; re-wrapped a couple of
...
wide paragraphs.
2001-02-01 15:53:24 +00:00
Fred Drake
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
Fred Drake
ebcf6a8573
Documentation for the weakref module.
2001-02-01 05:20:20 +00:00
Tim Peters
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
Barry Warsaw
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
Barry Warsaw
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
Eric S. Raymond
3229b859fb
More on noutrefresh() and scroll().
2001-01-29 06:39:33 +00:00
Skip Montanaro
4fda21ba6b
updated to document use of sequences of two-element tuples as inputs
2001-01-28 21:18:16 +00:00
Fred Drake
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
Eric S. Raymond
9ca35ec97a
Instructive example for strftime(); how to generate RFC822 dates.
2001-01-28 00:56:54 +00:00
Eric S. Raymond
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
Fred Drake
66f98b45cd
Fix a number of typos found by Guido.
2001-01-26 20:51:32 +00:00
Fred Drake
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
Tim Peters
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
Fred Drake
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
Tim Peters
517ce23183
Clarify winsound.beep docs, in response to c.l.py beep brouhahalet.
2001-01-25 09:33:48 +00:00
Tim Peters
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
Tim Peters
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
Barry Warsaw
83125775e0
A \begin{funcdesc} was closed with an \end{methoddesc}.
2001-01-25 00:39:16 +00:00
Barry Warsaw
21f37e1b88
Fixed a bug where \& was needed.
2001-01-25 00:38:15 +00:00
Barry Warsaw
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
Tim Peters
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
Fred Drake
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
Ka-Ping Yee
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
Fred Drake
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
Fredrik Lundh
0110d3b2ad
new unicodedata functions (name, lookup)
2001-01-24 08:10:07 +00:00
Skip Montanaro
eda28445c0
documented (new) optional doseq parameter to urlencode.
2001-01-24 06:36:06 +00:00
Eric S. Raymond
f79cb2db3e
Expose the autoraise capability. Improve the documentation.
2001-01-23 13:49:44 +00:00
Eric S. Raymond
aeb5532ca0
Oops...finish a mangled sentence.
2001-01-23 13:22:28 +00:00
Eric S. Raymond
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
ef8cd7ca99
Minor markup adjustment.
2001-01-22 17:42:32 +00:00
Thomas Wouters
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
Marc-André Lemburg
6f77667a64
Backed out the unistr() builtin.
2001-01-19 21:36:19 +00:00
Fred Drake
bc0b260a77
Minor markup cleaning, and one required fix in the unistr() description.
2001-01-18 18:09:07 +00:00
Skip Montanaro
9483bed6d9
correct typo - closes bug #129205
2001-01-18 10:44:08 +00:00
Ka-Ping Yee
3a9582fbe5
Fix the example (it didn't seem to reflect reality).
2001-01-18 07:50:17 +00:00
Marc-André Lemburg
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
Fred Drake
90badd1286
Add a missing newline in an example; caught by Chris Ryland
...
<cpr@emsoftware.com>.
2001-01-17 05:12:13 +00:00
Guido van Rossum
20ab9e9c0a
Document xreadlines() method. (Forgot to check this in before!)
2001-01-17 01:18:00 +00:00
Fred Drake
25be1931a0
Fix a few small markup/consistency nits.
2001-01-16 20:52:41 +00:00
Eric S. Raymond
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
Barry Warsaw
83ad5015cb
effbot caught a typo!
2001-01-15 20:51:40 +00:00
Barry Warsaw
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
Barry Warsaw
a770e866d6
Fixing author's email address.
2001-01-15 17:08:45 +00:00
Guido van Rossum
97d3b93c2f
Document changed default to passive mode.
2001-01-15 16:37:05 +00:00
Guido van Rossum
77b20f099e
Document filterwarnings(..., append=<bool>).
2001-01-14 14:10:18 +00:00
Fred Drake
1beb3d204f
Added note that this module was added in Python 2.1.
2001-01-12 22:57:32 +00:00
Fred Drake
ca7e1ee01a
Updated descriptions to incorporate additional information from Tim Peters.
...
This mostly closes SF bug #128251 .
2001-01-11 22:49:49 +00:00
Martin v. Löwis
a177c40daf
Document \code{import} in pth files.
2001-01-11 22:07:25 +00:00
Fred Drake
49c9ac30a4
Fixed minor markup nits for consistency with the rest of the library
...
reference.
2001-01-11 16:02:08 +00:00
Eric S. Raymond
ab78beca2f
Added pointer on POP3 variations.
2001-01-11 10:22:34 +00:00
Moshe Zadka
f68f2fec7d
Implementation of PEP-0217.
...
This closes the PEP, and patch 103170
2001-01-11 05:41:27 +00:00
Eric S. Raymond
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
Eric S. Raymond
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
Fred Drake
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
Fred Drake
986eafdc2b
Added missing word; fixed minor nits.
2001-01-09 20:54:15 +00:00
Fred Drake
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
Fred Drake
a5e7ad99d5
Documentation for the fpectl module, from Lee Busby. (Thanks!)
2001-01-09 20:38:54 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
b162d188f6
Fix typo spotted by Detlef Lannert <lannert@users.sourceforge.net>.
2001-01-04 05:48:08 +00:00
Fred Drake
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
Fred Drake
22e9a5eaec
Markup nit: OK and ERR should be marked \constant in running text.
2001-01-04 05:14:45 +00:00
Fred Drake
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
Fred Drake
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
Andrew M. Kuchling
be0630282e
Fix doubled word
2000-12-26 16:14:32 +00:00
Andrew M. Kuchling
8694cc42ab
Remove redundant reference to tab (since it = 'horizontal tab')
2000-12-26 16:09:37 +00:00
Andrew M. Kuchling
e6bf85845f
Document ERR and OK
2000-12-26 15:58:27 +00:00
Fred Drake
1dea760ca1
Make sure subsections are formatted into HTML pages with reasonable names.
2000-12-25 06:19:08 +00:00
Fred Drake
f08cbb1771
Added information on the ExternalEntityParserCreate() method.
2000-12-23 22:19:05 +00:00
Andrew M. Kuchling
5caee408b8
Add 'see also' link to curses.panel
2000-12-22 22:06:43 +00:00
Andrew M. Kuchling
676634beda
Added documentation for the panel wrapper module
2000-12-22 21:57:42 +00:00
Fred Drake
e412e7a3a0
Fix lots of small markup nits.
...
Wrapped some long lines.
2000-12-21 17:04:31 +00:00
Andrew M. Kuchling
68a6f5a0a2
Document the window.overlay() and .overwrite() methods
2000-12-21 16:25:44 +00:00
Guido van Rossum
5db5ba1ee3
Document the warnings module.
2000-12-19 06:01:23 +00:00
Guido van Rossum
1367b83797
Document warning categories.
2000-12-19 04:27:54 +00:00
Fred Drake
5b56765fe7
Added documentation on the ErrorHandler interface.
...
This closes bug #126034 .
2000-12-19 04:07:54 +00:00
Fred Drake
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
Neil Schemenauer
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
Fred Drake
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
Fred Drake
065cba1281
Added documentation for random.shuffle().
2000-12-15 19:07:17 +00:00
Fred Drake
29c45a5e91
Grant Griffin <grant.griffin@honeywell.com>:
...
Clarify that invert() is a *bitwise* operation.
2000-12-15 05:41:49 +00:00
Andrew M. Kuchling
4fb588240f
Document napms()
...
Add reference to demo directory
2000-12-15 01:03:23 +00:00
Fred Drake
f0b315478b
Update information on the locking() function, added the needed constants.
...
(Thanks for the info, Tim!)
2000-12-14 03:11:24 +00:00
Fred Drake
48971198c5
Finish a sentence that was left half-written!
2000-12-13 22:36:02 +00:00
Moshe Zadka
dd802208a7
Changing allow_reuse_address's default value, and documenting it.
2000-12-13 20:39:22 +00:00
Fred Drake
24d6da3eae
Added "stub" documentation for xml.dom.pulldom for Paul to fill out with
...
useful explanations.
2000-12-13 19:34:38 +00:00
Fred Drake
bc9c1b15cc
Added descriptions of the defined exceptions and their mapping to the
...
DOM recommendation.
2000-12-13 17:38:02 +00:00
Guido van Rossum
ff63f2023d
"Documentation" for {}.popitem().
2000-12-12 22:03:47 +00:00
Fred Drake
ed911b8cfb
Added link to HTML version of the NumPy documentation.
...
This closes bug #124943 .
2000-12-11 20:57:13 +00:00
Fred Drake
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
Fred Drake
9a29dd6580
Lots of small improvements and bits of added information on the DOM API.
2000-12-08 06:54:51 +00:00
Fred Drake
16942f2224
Lots of additional information. Not done, but much better.
2000-12-07 04:47:51 +00:00
Fred Drake
fd4d29cf5d
Typo caught by Jim Tittsler <jwt@onjapan.net>: They --> The
2000-12-07 00:03:24 +00:00
Fred Drake
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
Barry Warsaw
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
Fred Drake
21e4dd0492
Two typos caught by /F; thanks!
2000-12-04 22:29:17 +00:00
Fred Drake
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
Fred Drake
57657bce94
Update Moshe Zadka's email address to one works and might last a while.
2000-12-01 15:25:23 +00:00
Moshe Zadka
5725d1eb03
Backing out my changes.
...
Improved version coming soon to a Source Forge near you!
2000-11-30 19:30:21 +00:00
Moshe Zadka
1a62750eda
Added .first{item,value,key}() to dictionaries.
...
Complete with docos and tests.
OKed by Guido.
2000-11-30 12:31:03 +00:00
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
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
Fred Drake
6763b31731
Added brief explanation of the \versionchanged for 1.5.2 (fixes formatting
...
for the HTML version).
2000-11-28 06:39:28 +00:00
Fred Drake
2fef3abc74
Two minor nits.
2000-11-28 06:38:22 +00:00
Fred Drake
0ac000cd54
Updates to reflect pending changes to the XML conversion process.
2000-11-22 16:42:37 +00:00
Andrew M. Kuchling
620ec9d1ca
Document the new setupterm() function
2000-11-18 17:57:33 +00:00
Fred Drake
17383b9ad7
Added information about the %r string formatting conversion. Added note
...
about the interpretation of radix 0 for int(), and added description of
the optional radix argument for long(). Based on comments from Reuben
Sumner <rasumner@users.sourceforge.net>.
This closes bug #121672 .
2000-11-17 19:44:14 +00:00
Fred Drake
977fe96a05
Oops, back out change committed by accident! This is not ready, and
...
breaks things.
2000-11-17 19:09:34 +00:00
Fred Drake
2ed27d3189
Note that readframes() returns data in linear format, even if the original
...
is encoded in u-LAW format. Based on suggestion from Anthony Baxter
<anthony_baxter@users.sourceforge.net>.
This closes bug #122273 .
2000-11-17 19:05:12 +00:00
Fred Drake
d99e534de6
Fixed typos and bug in the second example, reported by Scott Schram
...
<schram@users.sourceforge.net>.
This closes bug #122236 .
2000-11-17 18:04:03 +00:00
Tim Peters
a3100de9ce
Fix for SF bug 122176: Error in rotor module documentation.
2000-11-14 21:43:01 +00:00
Andrew M. Kuchling
f16e0ed76c
Patch #102278 : add tparm() function to _curses module
2000-11-07 03:35:24 +00:00
Fred Drake
a776cea71a
Document the proper exception to be raised by I/O operations on closed
...
files; error reported by Ng Pheng Siong <ngps@post1.com>.
Make sure that various special object attributes are properly indexed.
2000-11-06 20:17:37 +00:00
Fred Drake
19647ca318
Typo: writeable --> writable
...
Reported by Erno Kuusela <erno@iki.fi>.
2000-11-01 03:12:34 +00:00
Fred Drake
efffe8e317
Many small markup revisions to be more consistent with markup elsewhere,
...
and to provide more consistent indexing.
Added an index entry.
Added documentation for the error and XMLParserType objects.
2000-10-29 05:10:30 +00:00
Fred Drake
3aecfc9681
Explained that os.path.basename() may return something different from the
...
basename program, as suggested by Gregor Hoffleit <gregor@hoffleit.de>.
This closes bug #119485 .
2000-10-26 21:38:23 +00:00
Fred Drake
53143bec9b
Since LookupError can be raised by sys.setdefaultencoding(), we should not
...
document it as only being a base class, not matter how unlikely this is
to affect normal users.
2000-10-25 21:05:29 +00:00
Fred Drake
1dba66cb72
Marc-Andre Lemburg <mal@lemburg.com> noted that the encode() string method
...
was added in 2.0.
2000-10-25 21:03:55 +00:00
Fred Drake
8940fafabd
Additions from Marc-Andre Lemburg <mal@lemburg.com>, documenting
...
getdefaultencoding() and setdefaultencoding().
2000-10-25 21:02:55 +00:00
Fred Drake
1491cace2a
Several additions and updates based on text from Marc-Andre Lemburg
...
<mal@lemburg.com>.
Lots of markup reformatting to make it easier for me to read & maintain.
2000-10-25 20:59:52 +00:00
Fred Drake
277a21150b
Added entries for the xml.dom.minidom module.
2000-10-24 02:35:42 +00:00
Fred Drake
669d36f02c
Paul Prescod <paul@prescod.net>:
...
Documentation for the xml.dom.minidom module & Python DOM API.
FLD: I have revised the markup in some places and added a few minor
details to Paul's text, but that's it. Given the substantial
structural differences with the bulk of the presentation, I will be
making additional revisions over the next few days.
2000-10-24 02:34:45 +00:00
Fred Drake
246f65f2bb
Correct the name of a parameter in the description of the register()
...
function.
This closes bug #117467 .
2000-10-23 15:41:13 +00:00
Fred Drake
8c2fd49cc3
Added missing entry for invert() function.
...
Added table mapping abstract operations to syntax to functions, based on
a suggestion from Bob Weiner <weiner@beopen.com>.
2000-10-22 03:19:30 +00:00
Fred Drake
4a152630ca
Capitalize first letter of an explanation for a \versionchanged
...
annotation.
2000-10-19 05:33:46 +00:00
Andrew M. Kuchling
75afc0b914
Document the .lastindex and .lastgroup attributes of MatchObject
2000-10-18 23:08:13 +00:00
Fred Drake
ba0a989988
Make all the \seemodule explanations consistent: start with a capitalized
...
letter and end with proper punctuation. "Documenting Python" will be
updated accordingly so that this will be editorial policy for the Python
documentation.
2000-10-18 17:43:06 +00:00
Fred Drake
510dfbad3d
Capitalize & use periods for \seemodule explanation parameter.
2000-10-18 16:47:52 +00:00
Fred Drake
b4b401eda3
Update the links to the NumPy website and documentation, based on a
...
comment from Janko Hauser <jhauser@ifm.uni-kiel.de>.
2000-10-17 04:58:01 +00:00
Fred Drake
21c9df7641
For os.stat() & friends, note that the time fields are returned as
...
floating-point values.
2000-10-14 05:46:11 +00:00
Fred Drake
602aa77d2f
Marc-Andre Lemburg <mal@lemburg.com>:
...
Documentation for the codec base classes.
Lots of markup adjustments by FLD.
This closes SourceForge bug #115308 , patch #101877 .
2000-10-12 20:50:55 +00:00
Fred Drake
babe326c65
Added entries for new files of SAX documentation.
2000-10-12 20:07:09 +00:00
Fred Drake
014f0e3394
Massive addition of SAX documentation from Martin von Loewis
...
<loewis@informatik.hu-berlin.de>.
Reorganized to be more like other parts of the documentation in its
arrangement, but with few content changes.
This closes SourceForge patch #101850 .
2000-10-12 20:05:09 +00:00
Fred Drake
93615657ec
Document the exceptions that now get raised on invalid parameters.
2000-10-11 22:27:51 +00:00
Fred Drake
6fe9bacb8c
Make sure methods of ZipFile objects are in alphabetical order; the logical
...
groupings are still maintained. Based on a comment by Steve Holden
<sholden@holdenweb.com>.
2000-10-11 18:56:00 +00:00
Fred Drake
2c4f554b78
Fixed a large number of small problems, mostly noted by Detlef Lannert
...
<lannert@lannert.rz.uni-duesseldorf.de>.
2000-10-10 22:00:03 +00:00
Fred Drake
66c9f0781d
Note that the UserString/MutableString classes are far less efficient
...
than the built-in string types (suggested by Moshe Zadka
<moshez@math.huji.ac.il>).
Clarified what "can be converted to a string" means.
Fixed a few markup nits.
2000-10-10 20:58:48 +00:00
Fred Drake
ef52f601ed
Revise the examples not to use the "from socket import *", and adjust
...
one comment in the example for clarity.
2000-10-10 20:36:29 +00:00
Fred Drake
0fc6a67307
Remove duplicated text from urlopen() description, noted by Ka-Ping
...
Yee <ping@lfw.org> and probably others as well.
2000-10-10 20:23:10 +00:00
Fred Drake
3ece71327f
Make it clear that copy_reg.pickle() should not be used for classes, but
...
only for extension types.
This partially fixes SourceForge bug #116295 .
2000-10-10 18:36:02 +00:00
Fred Drake
f8ca7d88c6
Fixed lots of small nits caught by Ka-Ping Yee <ping@lfw.org>.
2000-10-10 17:03:45 +00:00
Fred Drake
2d34cd3ecf
Minor nit fixes based on suggestions from Ka-Ping Yee <ping@lfw.org>.
...
Added "See also" section with relevant RFC references.
2000-10-10 17:02:34 +00:00
Fred Drake
25407882ea
Better synopsis based on suggestion from Ka-Ping Yee <ping@lfw.org>.
2000-10-10 16:59:53 +00:00
Fred Drake
4d3714b5c6
Better synopses based on suggestions from Ka-Ping Yee <ping@lfw.org>.
2000-10-10 16:56:41 +00:00
Fred Drake
6ff7aec2ab
Move the documentation for the mutex module to be with the threading
...
and queue-management modules, since that is where the general context
for use in most cases.
2000-10-10 16:46:36 +00:00
Fred Drake
17a2b640e4
Work around annoyances in LaTeX2HTML.
2000-10-09 18:12:29 +00:00
Fred Drake
955e03bd68
Push xmllib to the end of the markup chapter since it is deprecated.
2000-10-09 18:11:24 +00:00
Fred Drake
3383792c74
Denis S. Otkidach <ods@users.sourceforge.net>:
...
Correct description of leapdays() function.
This closes SourceForge patch #101840 .
2000-10-09 15:27:31 +00:00
Fred Drake
c2bac8745d
Include more information from the docstrings.
2000-10-06 21:07:14 +00:00
Fred Drake
519744409b
Fix really bad typo, noted by Neil Schemenauer <nas@arctrix.com>.
2000-10-06 20:16:50 +00:00
Fred Drake
c6243e4e08
Add notes on the requirements for subclasses.
...
This closes SourceForge bug #115928 .
2000-10-06 20:04:48 +00:00
Fred Drake
2e06c209dc
Revise the versioning information to say that this was revised in 1.6,
...
not added then, and note what the change was (ncurses, change to a package).
2000-10-06 20:01:23 +00:00
Fred Drake
062ea2e70b
Made a number of revisions suggested by Fredrik Lundh.
...
Revised the first paragraph so it doesn't sound like it was written
when 7-bit strings were assumed; note that Unicode strings can be used.
2000-10-06 19:59:22 +00:00
Fred Drake
d88d0a1d5b
It turns out that Guido does not like or encourage the use of the term
...
"disciplines" for the __*__() methods, so they should be referred to as
"methods" or "special methods", as appropriate in context.
2000-10-06 19:39:47 +00:00
Fred Drake
5d63a39983
is_zipfile() description: Use the same name for the parameter as the
...
code, in case someone wants to use it as a keyword paramter.
ZIP_DEFLATED description: Do not reveal the specific value of the
constant, since code should only use the symbolic name.
2000-10-06 15:29:56 +00:00
Andrew M. Kuchling
9351dd2084
Document the lookbehind assertions (closing bug#115119)
2000-10-05 15:22:28 +00:00
Andrew M. Kuchling
7a90db6131
Document expand() method of MatchObjects
2000-10-05 12:35:29 +00:00
Neil Schemenauer
b2c2c9e977
- update Neil's email address
2000-10-04 16:34:09 +00:00
Fred Drake
15f06661c1
Added deprecation notices to atof(), atoi(), and atol(), recommending
...
use of the float(), int(), and long() built-ins instead.
Fixed minor markup nit elsewhere (use of \optional).
2000-10-04 13:59:52 +00:00
Fred Drake
c71c23e392
Added \versionchanged comment to os.popen() noting that it was unreliable
...
in earlier versions of Python; this is useful information for people
interested in writing code that is portable across Python versions.
Suggested by Peter Funk <pf@artcom-gmbh.de>.
2000-10-04 13:57:27 +00:00
Fred Drake
0b4e25d0c0
Use \obindex{...} instead of \indexii{...}{type} in many places; this is
...
more consistent with other index entries in the documentation.
2000-10-04 04:21:19 +00:00
Fred Drake
1319e3ecbc
Remove old note that os.popen() on Windows is unreliable; this is no
...
longer true.
2000-10-03 17:14:27 +00:00
Fred Drake
e35360ffd0
Jim Ahlstrom sent a few corrections to my changes. (Thanks!)
2000-10-03 15:16:31 +00:00
Fred Drake
58a2dff7f4
Replace minimal \seetext references with better annotated \seerfc
...
references, telling the reader more about what to expect at the other end
of the links.
2000-10-03 05:56:55 +00:00
Fred Drake
296b8f5bd2
Add deprecation note since the XML support is shaping up.
2000-10-02 22:14:09 +00:00
Fred Drake
427802470a
Substantially revised documentation for the zipfile module, partially based
...
on revised text from Jim Ahlstrom <jim@interet.com>.
This closes SourceForge bug #115681 .
2000-10-02 20:56:30 +00:00
Fred Drake
f6791f3d12
Minor usage fix.
...
Add a note that some way of reliably detecting the use of KDE would be
really nice.
2000-10-02 03:42:43 +00:00
Fred Drake
8d3312f4d1
Add documentation and warnings for the isCallable(), isMappingType(),
...
isNumberType(), and isSequenceType() functions.
This closes SourceForge bug #115789 .
2000-10-02 03:36:18 +00:00
Martin v. Löwis
d15a9427e8
Fixed spelling of module; closes bug 115712.
2000-09-30 17:04:40 +00:00
Fred Drake
58295dedf7
Replace to XXX notes to add references with real references.
2000-09-30 00:11:45 +00:00
Fred Drake
4ce4f2eedd
os.startfile() documentation, based on text from Tim Peters.
2000-09-29 04:15:19 +00:00
Fred Drake
8a9db99760
Updated documentation relating to the various flavors of popen[234]()
...
for Windows & Unix.
2000-09-28 20:27:51 +00:00
Fred Drake
44774c9429
Add regex and regsub to the list of undocumented obsolete modules.
2000-09-28 05:31:39 +00:00
Fred Drake
33dde92ecf
Update the documentation for ConfigParser to match the recent changes.
2000-09-27 22:48:44 +00:00
Fred Drake
7f577e7fd4
regex and regsub are obsolete and Evil, so don't include them in the club.
2000-09-25 18:26:21 +00:00
Fred Drake
e53793bf4c
Updates from Fredrik Lundh <effbot@telia.com> about Unicode-related
...
behavior.
2000-09-25 17:52:40 +00:00
Fred Drake
ef5781b8c8
Add obsolescence note to the module descriptions that get added to the
...
list of module synopses at the front of the chapter; based on a comment
from Aahz <aahz@panix.com>.
2000-09-25 17:23:04 +00:00
Fred Drake
d79c33a47b
Minor cleanups, wrap long lines.
2000-09-25 14:14:30 +00:00
Fred Drake
7be3115860
Added explanation of the use of the first program argument passed to the
...
exec*() family of functions.
2000-09-23 05:22:07 +00:00
Fred Drake
7fbc85c5c5
Rename the public interface from "pyexpat" to "xml.parsers.expat".
2000-09-23 04:47:56 +00:00
Fred Drake
c32741d1ab
Added warnings about platform vagaries to the strptime() documentation.
...
This closes SourceForge bug #115146 .
2000-09-23 04:36:14 +00:00
Neil Schemenauer
544de1effb
- Add DEBUG_SAVEALL option. When enabled all garbage objects found by the
...
collector will be saved in gc.garbage. This is useful for debugging a
program that creates reference cycles.
- Fix else statements in gcmodule.c to conform to Python coding standards.
2000-09-22 15:22:38 +00:00
Fred Drake
ed773ef78d
Include the new text on reporting bugs in a few useful places.
...
This closes SourceForge bug #114792 .
2000-09-21 21:35:22 +00:00
Fred Drake
1bf4e93180
Convert the longest two tables from tableii to longtableii so they do not
...
make too big a mess. One actually did not fit on a single page at all!
2000-09-21 16:04:08 +00:00
Fred Drake
fffe5dbc47
Fixed a number of small problems reported by Detlef Lannert
...
<lannert@uni-duesseldorf.de>.
2000-09-21 05:25:30 +00:00
Fred Drake
51f53df4c8
Clarify that the softspace attribute is used by print for state management,
...
not as a user-controlled parameter.
2000-09-20 04:48:20 +00:00
Fred Drake
f5aa4ef07c
Add entries for the xml.sax documentation.
2000-09-20 02:54:58 +00:00
Fred Drake
e10ef74bb8
First cut at documentation for the xml.sax package (not including any
...
sub-modules).
2000-09-20 02:52:20 +00:00
Fred Drake
752ba39a0b
Clarify a number of issues about the file-like object API based on
...
discussion on python-dev.
2000-09-19 15:18:51 +00:00
Fred Drake
480abc2751
Document the "printable" and "punctuation" constants added to the string
...
module.
2000-09-18 16:48:13 +00:00
Fred Drake
1675375a7c
Add missing \declaremodule for zipfile.
2000-09-18 16:21:11 +00:00
Tim Peters
1de8098ca6
Repaired some glitches in the MD5 and SHA docs; copied the descriptions of
...
the MD5 methods into the SHA docs (substituting "sha" for "md5", of course,
and changing the stuff that depended on digest size accordingly).
Fred, don't trust me!
2000-09-18 15:34:57 +00:00
Fred Drake
5316ef4bbb
Added documentation for new functions.
...
Deprecated sequenceIncludes().
Based on patch by Denis S. Otkidach <ods@users.sourceforge.net>,
this closes SourceForge patch #101390 .
2000-09-17 16:10:25 +00:00
Fred Drake
6e1fecc28a
Update URL to unicode.org's FTP site using an HTTP URL to the same
...
document.
2000-09-16 13:46:42 +00:00
Fred Drake
315b9e0ac1
Update *both* uses of the URL to the zlib home page, and use the version
...
advertised as the canonical form.
2000-09-16 06:18:26 +00:00
Fred Drake
ab2f9f766f
Update link to the zlib homepage.
2000-09-16 05:07:03 +00:00
Fred Drake
f29107447a
Update the link to Andrew Kuchling's crypto code.
2000-09-16 05:02:24 +00:00
Fred Drake
91fc9319fa
Update link to the FIPS PUB 180-1 (PDF is available, but not PostScript).
2000-09-16 04:59:33 +00:00
Tim Peters
78fc0b57df
Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
...
FRED, please check my monkey-see-monkey-do Tex fiddling!
2000-09-16 03:54:24 +00:00
Fred Drake
7c25f3df85
Add some comments on the available implementations that this module can
...
use.
Change the list of flag values for open() to a table.
Markup consistency nits.
2000-09-15 21:31:31 +00:00
Skip Montanaro
6634b14f3b
add cross reference to mimetools module
2000-09-15 18:20:20 +00:00
Fred Drake
6e5184fe6a
Update comments in the second paragraph, discussing versioning issues
...
related to the BSD DB library. Based on comments from Mark Summerfield
<summer@netcraft.com>.
2000-09-15 15:19:35 +00:00
Fred Drake
81c1735809
Add item to the list of limitations that points out the lack of support
...
for authenticated proxies. This is noted elsewhere, but this makes it
easier to find.
Fix typo where it was already mentioned.
This closes SourceForge bug #110619 .
2000-09-15 04:12:56 +00:00
Fred Drake
4dfad57235
Add a reference to the sha module, noting that SHA is considered more
...
secure. Suggested by Erno Kuusela <erno@iki.fi>.
2000-09-14 21:47:32 +00:00
Fred Drake
b9fd468ded
Convert "See also" section to use \seetitle.
2000-09-14 21:46:22 +00:00
Fred Drake
6ba0a3c30a
Denis S. Otkidach <ods@users.sourceforge.net>:
...
Minor fix in documentation of code module.
(Clarifies output destination for default implementation of the write()
method.)
2000-09-14 20:42:53 +00:00
Fred Drake
7a666b83c8
Remove reference to the stdwin-based windowed debugger, since stdwin
...
is gone.
Make a module reference into a hyperlink.
2000-09-14 20:32:17 +00:00
Fred Drake
d5d0435617
Use \shortversion in a number of places.
...
This partially addresses SourceForge bug #114318 .
2000-09-14 20:24:17 +00:00
Fred Drake
1fe3b82371
Avoid reference to specific versions of Python where possible.
...
This partially addresses SourceForge bug #114318 .
2000-09-14 18:25:41 +00:00
Fred Drake
66d32b1e12
Add some index entries to make it easier to find information on
...
%-formatting of strings.
2000-09-14 17:57:42 +00:00
Barry Warsaw
ddef8887db
Include a link to Francois's po-utils.
2000-09-13 12:04:47 +00:00
Fred Drake
ae86d43f11
Add a reference item pointing to the Namespaces in XML recommendation.
...
Convert the existing reference items to \seetitle markup.
2000-09-12 17:53:48 +00:00
Fred Drake
1349437e4c
When referring to namespaces, always say "namespaces" instead of
...
"name spaces".
Inconsistency noted by Keith Briggs <keith.briggs@bt.com>.
2000-09-12 16:23:48 +00:00
Fred Drake
88fa9627b1
Some updates and fix a bunch of really small consistency nits.
2000-09-11 05:23:25 +00:00
Fred Drake
1b194f927d
Add a reference to the material on string methods.
2000-09-09 05:34:06 +00:00
Fred Drake
f96e0d203b
Various clarifications and minor nits fixed. Affected descriptions of
...
input(), locals(), reload(), unicode(), and zip().
2000-09-09 03:33:42 +00:00
Fred Drake
1172a85175
Really minor consistency nit.
2000-09-09 03:31:17 +00:00
Fred Drake
66571cc20c
Improve a couple of references to the language reference, making them
...
hyperlinks to relevant sections.
Clarify the conditions under which the "softspace" attribute of file-like
objects can "just work" (with relation to overriding of attribute access
in user-defined classes).
2000-09-09 03:30:34 +00:00
Fred Drake
7acb21866c
Minor clarifications in the introductory paragraph.
2000-09-09 03:28:00 +00:00
Fred Drake
e544191397
Add \modulesynopsis for inclusion in the list of modules at the beginning
...
of the chapter.
Add explanation that this is only available when the cycle detector is
enabled at build time.
2000-09-09 03:26:51 +00:00
Fred Drake
1c4efad770
Move the "See also" section to a location more consistent with other
...
module sections. Properly mark the name of the module in the content
of the reference there.
2000-09-09 03:25:11 +00:00
Fred Drake
621d2bee1c
Move description of UserString.MutableString to a location more typical
...
of the arrangement of other modules.
2000-09-09 03:23:50 +00:00
Fred Drake
d0726c3cd9
\file is not allowed in section titles -- converting to PDF fails due to
...
weird macro-expansion issues. A better solution may be available in the
future, but this will do for now.
Add an index entry. More should probably be added as well.
2000-09-07 18:55:08 +00:00
Fred Drake
88c023b863
Remove comment about -X and string exceptions. Error noted by
...
Justin D. Pettit <jpettit@raznick.com>.
2000-09-07 16:33:32 +00:00
Fred Drake
6300bd42a4
Added note about Python version this was added for.
2000-09-07 14:01:40 +00:00
Fred Drake
77a6c9ece5
Minor markup nits around use of \optional.
2000-09-07 14:00:51 +00:00
Fred Drake
8b2e8f846c
Added a \versionadded statement to the getfqdn() description.
2000-09-06 02:22:16 +00:00
Fred Drake
8ff4cd7512
Minor markup revisions for consistency with the rest of the documentation.
2000-09-05 13:50:21 +00:00
Fred Drake
0d83f68fc9
Added entry for mmap module.
2000-09-05 13:49:30 +00:00
Barry Warsaw
21fbd540ed
Document the new optional argument "rest" on the transfercmd(),
...
ntransfercmd(), and retrbinary() commands. This closes SF patch
#101187 .
2000-09-01 06:32:32 +00:00
Fred Drake
65faf118b6
Fix markup error and minor consistency nit.
2000-08-31 19:35:56 +00:00
Jeremy Hylton
ee5adfbae6
add user-modifiable recursion_limit
...
ceval.c:
define recurion_limit (static), default value is 2500
define Py_GetRecursionLimit and Py_SetRecursionLimit
raise RuntimeError if limit is exceeded
PC/config.h:
remove plat-specific definition
sysmodule.c:
add sys.(get|set)recursionlimit
2000-08-31 19:23:01 +00:00
Fred Drake
aef0e890b5
Document the limitation that urllib does not work with proxies which
...
require authenication. This is an implementation limitation rather than
required behavior, and may be fixed in the future.
This closes SourceForge bug #111725 .
2000-08-31 17:23:35 +00:00
Fred Drake
4c3f797128
UNARY_NEG is supposed to be UNARY_NEGATIVE (spotted by Charles Waldman
...
<cgw@fnal.gov>).
Fix minor problem with EXTENDED_ARG description markup..
2000-08-31 16:26:35 +00:00
Sjoerd Mullender
1c8feae411
New method getnamespace.
...
Since the application never gets to see the namespace abbreviation
used in the XML document, but some applications may need to know them,
we provide this method.
2000-08-31 10:27:00 +00:00
Fred Drake
fcab76350a
Relocate the popen2 documentation since it is now substantially more
...
portable.
2000-08-31 06:09:26 +00:00
Skip Montanaro
7b828a6a56
doc changes to parallel changes to calendar.py module
2000-08-30 14:02:25 +00:00
Fred Drake
d576e9df5f
Markup revisions. Nothing was actually required to be able to format it,
...
but many conventions were broken.
2000-08-30 04:19:20 +00:00
Barry Warsaw
28b815f28a
Oops, spell MAL's name right.
2000-08-30 03:28:17 +00:00
Barry Warsaw
0691a6b8ed
Documentation for the gettext module.
2000-08-30 03:27:10 +00:00
Barry Warsaw
058365aec5
Added libgettext.tex
2000-08-30 03:26:17 +00:00
Moshe Zadka
a1a4b5916b
Closing patch #101120 -- After everyone agreed.
2000-08-25 21:47:56 +00:00
Fred Drake
0308ff8652
Add reference to RFC 2396 in "See also" section.
...
Minor cleanups.
2000-08-25 17:29:35 +00:00
Fred Drake
dfca4dc503
Revised documentation relevant to SourceForge patch #100837
...
(simplify making HTTP POST requests).
Added documentation of URLopener.version and how it can be overridden.
2000-08-25 05:13:42 +00:00
Andrew M. Kuchling
99a3701618
Documentation for poll() interface (SF patch #100852 )
2000-08-25 01:21:28 +00:00
Thomas Wouters
12bba852a9
Rough and incomplete documentation on augmented assignment, which follows
...
shortly. Markup also needs checking.
2000-08-24 20:06:04 +00:00
Guido van Rossum
3d0c77b37c
Addresses the other half of Bug #112634 -- the documentation suggested
...
that you can set self.version *after* calling the base class __init__.
In fact it must be done *before*.
(Fred, maybe the version class variable should be documented now?)
2000-08-24 16:20:32 +00:00
Fred Drake
45ca3331d9
Move references to RFCs to a "See also" section for consistency with
...
other sections of the library reference.
2000-08-24 04:58:25 +00:00
Fred Drake
9fa4d61bcc
Moshe Zadka <moshez@math.huji.ac.il>:
...
Documentation updates for urlretrieve() and URLopener.retrieve(), to
reflect Randall Hopper's patch for those functions.
This closes SourceForge patch #100837 .
2000-08-24 01:06:40 +00:00
Fred Drake
093272ea85
Charles G. Waldman <cgw@fnal.gov>:
...
Update the dis module documentation to reflect the EXTENDED_ARG opcode.
2000-08-24 00:37:50 +00:00
Skip Montanaro
297bf7ceb5
update commonprefix doc to make sure user is aware it works
...
character-by-character and that that behavior may result in it returning
prefixes that are not valid paths
2000-08-23 16:58:32 +00:00
Barry Warsaw
9087688581
Describe the new PRINT_ITEM_TO and PRINT_NEWLINE_TO opcodes.
2000-08-21 17:19:00 +00:00
Andrew M. Kuchling
120beb6b67
Strengthen the warning against using SerialCookie and SmartCookie.
...
(If they're security holes, should they be documented at all?)
Minor rewrites.
2000-08-20 23:33:50 +00:00
Fred Drake
15446d344d
Add entry for Cookie module.
2000-08-19 16:55:31 +00:00
Fred Drake
e5c7352201
Make it format.
...
Adjust markup for hyperlinking to the relevant RFCs.
Give it a little organization.
Minor nits.
2000-08-19 16:54:57 +00:00
Moshe Zadka
1b07f2bcf6
Initial revision. Markup unchecked.
2000-08-19 14:11:41 +00:00
Fred Drake
512bb72fb0
As pointed out by Denis S. Otkidach <den@analyt.chem.msu.ru>, xrange()
...
returns an xrange object, not a range object, despite the name of the
source file they're implemented in.
In the list of comparison operators, list != before <>, since <> is
described as obsolescent.
2000-08-18 03:12:38 +00:00
Fred Drake
304faf944c
Fix a markup error that caused formatting to fail.
...
Lots of minor markup adjustments as well.
2000-08-18 02:15:55 +00:00
Andrew M. Kuchling
0690c86a2a
Document the returns_unicode attribute
2000-08-17 23:15:21 +00:00
Thomas Wouters
5215225ea1
Apply SF patch #101135 , adding 'import module as m' and 'from module import
...
name as n'. By doing some twists and turns, "as" is not a reserved word.
There is a slight change in semantics for 'from module import name' (it will
now honour the 'global' keyword) but only in cases that are explicitly
undocumented.
2000-08-17 22:55:00 +00:00
Fred Drake
dd611b0070
A little more text, and some really minor cleanups.
2000-08-17 22:31:23 +00:00
Fred Drake
e581bb30c4
Small cleanups, and note when zip() entered the menagerie.
2000-08-17 22:30:30 +00:00
Fred Drake
b32aa5ecef
Revise the comments about the exceptions module to not refer to source
...
code; it is not sufficiently readable now that it in written in C, and
is less likely to be available to end users.
2000-08-17 22:29:31 +00:00
Fred Drake
25699f99f4
Martin v. Loewis <martin@loewis.home.cs.tu-berlin.de>:
...
Document opcodes added to support extended call syntax.
2000-08-17 22:19:26 +00:00
Fred Drake
5772c86816
Document socket.getfqdn().
2000-08-16 14:21:42 +00:00
Thomas Wouters
caa658d047
Apply SF patch #101151 , by Peter S-K, which fixes smtplib's passing of the
...
'helo' and 'ehlo' message, and exports the 'make_fqdn' function. This
function should be moved to socket.py, if that module ever gets a Python
wrapper.
2000-08-15 19:30:36 +00:00
Fred Drake
d066f6d780
Fix markup bug that prevented formatting.
...
Adjusted some markup for consistency with the rest of the documentation
and creation of the proper index entries.
2000-08-15 17:47:09 +00:00
Barry Warsaw
0be4346da6
Describe the b2a_hex() and a2b_hex() functions (a.k.a. hexlify() and
...
unhexlify() respectively).
2000-08-15 06:08:00 +00:00
Barry Warsaw
4ef4be53ac
Added description of the md5.hexdigest() method.
2000-08-15 06:00:28 +00:00
Fred Drake
a2b6ad6e27
Guido pointed out that all names in the sys module have no underscore,
2000-08-15 04:24:43 +00:00
Fred Drake
68e2915fc7
Document the byte_order value in the sys module.
2000-08-14 15:47:30 +00:00
Fred Drake
107b9679c4
Document the range type, as suggested by Denis S. Otkidach
...
<den@analyt.chem.msu.ru>.
2000-08-14 15:37:59 +00:00
Fred Drake
4de96c2fd8
Added Marc-Andre Lemburg's documentation for string methods, with some
...
massaging for markup consistency. This closes SourceForge patch #101063 .
Added Unicode strings and buffer objects to the list of sequence types.
Small markup nits elsewhere.
2000-08-12 03:36:23 +00:00
Thomas Wouters
0be5aab04d
Merge UNPACK_LIST and UNPACK_TUPLE into a single UNPACK_SEQUENCE, since they
...
did the same anyway.
I'm not sure what to do with Tools/compiler/compiler/* -- that isn't part of
distutils, is it ? Should it try to be compatible with old bytecode version ?
2000-08-11 22:15:52 +00:00
Fred Drake
46479d3740
Some minor clarifications and added some index entries.
2000-08-11 20:34:27 +00:00
Fred Drake
3ac977e39c
O_BINARY: Documented this constant; omission noted by David Ascher.
...
access(): Corrected availability statement; error pointed out by
Tim Peters.
2000-08-11 20:19:51 +00:00
Fred Drake
a8e484c8f5
getopt(): revise description of long_options parameter slightly so it will
...
be less confusing; add a paragraph separation so that comments about
the options and long_options parameters don't have references that
are easily misinterpreted.
Adjust the interactive examples to not need the string module.
Add an example showing how the module is commonly used in a script.
2000-08-11 19:55:06 +00:00
Peter Schneider-Kamp
10e1bf2f64
remove all occurence of math.rint() from the sources
...
(and yes, "Currintly" also counts <0.5 wink>)
2000-08-10 04:23:30 +00:00
Eric S. Raymond
65983372f0
More on noutrefresh.
2000-08-09 21:49:31 +00:00
Eric S. Raymond
1ebd3f6c4b
Tweak curses.wrapper so it initializes colors if they are available.
2000-08-09 21:11:07 +00:00
Fred Drake
3fe9a98c95
Correct markup error.
2000-08-09 14:37:05 +00:00
Fred Drake
fc1f9229f4
Correct version number at which the curses.ascii module was introduced.
2000-08-09 14:36:11 +00:00
Fred Drake
ec4b2af6bb
Fix a few markup errors and lots of small consistency issues.
...
Add "See also" link to curses.wrapper module from curses module.
2000-08-09 14:34:48 +00:00
Guido van Rossum
8141cf5c76
Barry's patch to document the new setdefault() method. Slightly
...
clarified the summary for default() in the table to indicate the side
effect.
2000-08-08 16:15:49 +00:00
Vladimir Marangozov
f9d20c3786
Neil Schemenauer: GC enable(), disable(), isenabled() interface.
...
Small stylistic changes by VM:
- is_enabled() -> isenabled()
- static ... Py_<func> -> static ... gc_<func>
2000-08-06 22:45:31 +00:00
Eric S. Raymond
5a007693c1
Documented curses.wrapper and curses.textpad.
2000-08-04 07:35:41 +00:00
Fred Drake
ed13b4a5a6
Break the "Python Services" chapter into two: "Python Runtime Services"
...
(still at the start of the manual), and "Python Language Services" (late
in the manual). Moved "Restricted Execution" to just before "Python
Language Services."
2000-08-03 21:18:18 +00:00
Fred Drake
8b168ba505
int() description: Fix markup to avoid image generation for math mode.
...
zip() description: Fix broken markup, three small markup consistency nits,
and one really minor usage nit. Introduce use of \moreargs instead
of hardcoding "..." with \optional.
2000-08-03 17:29:13 +00:00
Barry Warsaw
faefa2a885
Both PEP 201 Lockstep Iteration and SF patch #101030 have been
...
accepted by the BDFL.
Added documentation for zip() builtin.
2000-08-03 15:46:17 +00:00
Fred Drake
6c7a46a2f0
Rob Hooft <rob@hooft.net>:
...
Description of fcntl(): Added description of what can go wrong.
2000-08-02 20:53:51 +00:00
Mark Hammond
21a4764b9a
As requested by Fred - mention that in the future a winreg module may make a comeback.
2000-08-01 23:49:50 +00:00
Peter Schneider-Kamp
f917bf6080
fixing a minor spelling mistake
2000-08-01 00:07:17 +00:00
Fred Drake
fbd3b45bb7
Stop lying about [].pop() being experimental! There is no backing it out
...
at this point.
2000-07-31 23:42:23 +00:00
Peter Schneider-Kamp
5a65c2d436
added count, extend, index, pop and remove to arraymodule
2000-07-31 20:52:21 +00:00
Fred Drake
1e75e1776f
Two minor nits from Gerry Weiner (no working email address) about
...
describing the methods of dictionaries.
2000-07-31 16:34:46 +00:00
Fred Drake
578a3f9638
Moshe Zadka <mzadka@geocities.com>:
...
Document new method in shutil (copyfileobj).
Minor clarification by Fred.
2000-07-31 15:45:46 +00:00
Fred Drake
10853c9835
Finally fixed the much-reported bug about "~" in a couple of example.
...
This time, it was reported by Skip.
2000-07-28 13:51:27 +00:00
Eric S. Raymond
b924bd4610
Second round of curses documentation improvements. Completes and extends
...
documentation for function keys, special characters.
2000-07-27 21:10:02 +00:00
Andrew M. Kuchling
1962fb59f3
Document tiget{flag,num,str}
2000-07-26 02:59:13 +00:00
Fred Drake
e1b304db37
Fix small typos and markup consistency nits.
2000-07-24 19:35:52 +00:00
Eric S. Raymond
6899660a81
First round of curses documentation improvements; correct errors, flesh out
...
entry point descriptions.
2000-07-24 03:28:40 +00:00
Skip Montanaro
d372521ec0
added doc for isatty()
2000-07-19 17:30:58 +00:00
Skip Montanaro
7cb1524586
added documentation for new functions {get,set}_history_length
2000-07-19 16:56:26 +00:00
Thomas Wouters
f8316638af
Rob W. W. Hooft's spelling fixes for the Library Reference. I hope
...
SourceForge doesn't choke on this batch :-)
I'm not entirely sure this is 100% correct. The patch changes an
\index{persistency} to \index{presistence}, and I don't know what \index{}
does. But it seems to do so persi--er, consistently, so I hope it isn't a
problem.
2000-07-16 19:01:10 +00:00
Eric S. Raymond
f868de6491
Document the second round of ConfigParser changes.
2000-07-14 15:00:02 +00:00
Andrew M. Kuchling
8d2f2b2db2
From Sam Rushing's Medusa, via SF patch #100858 : add & document
...
os.seteuid(), os.setegid(), os.setreuid(), os.setregid().
2000-07-13 01:26:58 +00:00
Fred Drake
bdcf91fda0
Documentation for the gc module. Text from Neil Schemenauer
...
<nascheme@enme.ucalgary.ca>, markup & minor revisions from Fred
Drake.
2000-07-12 04:22:53 +00:00
Eric S. Raymond
7ae3a5e79d
Resynchronize the TeX docs with (a) the module docstring, and (b) my recent
...
fix to the code to make it behave like the module docstring.
2000-07-12 02:56:15 +00:00
Fred Drake
acab3d61e9
Change the table in the pyexpat.errors module to a series of datadesc
...
elements (since the table was pretty screwed up); this is how it is done
elsewhere in the manual.
I could use some help creating descriptions of the specific error
identifiers (input conditions that lead to each error, etc.).
2000-07-11 16:30:30 +00:00
Eric S. Raymond
417c489def
Give ConfigParser the capability to set as well as read options, and to write
...
a representation of the configuration state in .ini format that can be read
back in by a future read() call. Thus this class is now a back end
for .ini editors as well as parsers.
This patch is complete and tested, but exposes a bug in the ConfigParser
implementation which I have not yet fixed. Because case information is
discarded during parsing, the output of write() has its case smashed.
I wrote this for a SourceForge interface script called forgetool.
Documentation for the new entry points included.
2000-07-10 18:11:00 +00:00
Fred Drake
146b28086f
Minor revisions similar to some information in the new docstrings.
2000-07-08 16:59:03 +00:00
Fred Drake
c826ecbf8f
Add an entry for the KDE File Manager support from Peter Funk.
2000-07-07 17:08:40 +00:00
Fred Drake
e4dbb86ab8
New module webbrowser. Easy-to-use controller objects to make using a
...
Web browser as a help/information browser easy across platforms.
2000-07-07 03:36:12 +00:00
Fred Drake
aa7524cf1f
Clean up markup to be more like recommended practice; only small changes
...
needed.
2000-07-06 18:37:08 +00:00
Fred Drake
29fa30ea6b
Correct a markup nit that caused a space to be dropped from the HTML
...
version (actually a LaTeX2HTML bug), and clarified a sentence in the
mktime() description based entirely on comments from Grant Griffin
<grant.griffin@honeywell.com>.
2000-07-06 18:09:02 +00:00
Fred Drake
3c62d9e656
Several small changes, mostly to the markup, to improve consistency and
...
internal hyperlinking. Move some things around, also for consistency
with other modules ("See also" stuff tends to live at the \section level,
before sub-sections, etc.).
2000-07-06 04:51:04 +00:00
Fred Drake
14ea85f325
Add entry for readline documentation.
2000-07-06 04:47:25 +00:00
Fred Drake
011028cf74
Sjoerd Mullender <sjoerd@oratrix.nl>:
...
Updates for recent changes in xmllib.
2000-07-06 04:45:14 +00:00
Fred Drake
d14423abe2
Correct typo in description of the machine name parameter to the
...
ConnectRegistry() function; there is no trailing period!
2000-07-06 04:38:37 +00:00
Skip Montanaro
63099f911f
added seealso pointing reader at readline example which uses atexit.
2000-07-06 03:26:39 +00:00
Skip Montanaro
510ca1d338
simple-minded readline section doc based upon module's doc strings.
2000-07-06 03:25:26 +00:00
Skip Montanaro
0915165096
added warning about incompatibility with other codes' use of sys.exitfunc.
2000-07-05 23:11:26 +00:00
Fred Drake
b5316188ee
Created a new chapter on structured markup processing, including the
...
existing SGML, HTML, & XML support, and providing a home for the new
XML support as it becomes documented.
2000-07-05 02:24:39 +00:00
Fred Drake
c05cbb0527
Wrapped some long lines.
...
Cleaned up the table of error constants defined in pyexpat.errors; an
extra pair of braces had pretty much destroyed the table! (Not sure why.)
Moved the pyexpat.errors module documentation into a \section with the
proper headers for a module.
2000-07-05 02:03:34 +00:00
Fred Drake
25e7cee1c8
get_starttag_text(): Document this method.
2000-07-03 14:32:04 +00:00
Fred Drake
52dc76c81f
Eric S. Raymond <esr@thyrsus.com>:
...
This patch implements relative-path semantics for the "source" facility resembling
those of cpp(1), documents the change, and improves the shlex test main to
make it easier to test this feature. Along the way, it fixes a name error
in the existing docs.
[Additional documentation markup changes for consistency by FLD.]
2000-07-03 09:56:23 +00:00
Fred Drake
353aaadd9b
Moshe Zadka <moshez@math.huji.ac.il>:
...
Substantial updates to reflect Moshe's Gordon's enhancements to the
module.
Additional changes from Fred to reflect his changes to the module as well.
2000-07-03 08:24:49 +00:00
Fred Drake
fcc95a4d04
Tim-blessed documentation for math.frexp().
2000-07-03 06:38:17 +00:00
Fred Drake
c3a65982a3
others --> other's (possessive)
...
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:47:38 +00:00
Fred Drake
506a7a87ff
Send a "ARTICLE" --> Send an "ARTICLE"
...
Usage error noted by Grant Griffin <grant.griffin@iowegian.com>.
2000-07-01 17:43:19 +00:00
Fred Drake
30f76ffd00
Update version numbering from 1.6 to 2.0.
2000-06-30 16:06:19 +00:00
Fred Drake
f0e88980f3
Document randrange().
2000-06-30 15:32:31 +00:00
Fred Drake
57a2f7f8ef
Change description of altzone to not refer to the "0th meridian".
2000-06-30 04:24:52 +00:00
Fred Drake
9a748aa832
Say "manual page", not "man page", when referring to the Unix manual.
2000-06-30 04:21:41 +00:00
Fred Drake
abbc7344a4
Make sure to note that this module was added for Python 2.0!
2000-06-30 03:50:06 +00:00
Fred Drake
6e71cdd9f1
Reflect the name change to _winreg; we still need documentation for the
...
new winreg module.
2000-06-30 03:45:40 +00:00
Andrew M. Kuchling
efc43d4478
Document recently-added mouse-related functions
2000-06-30 01:05:39 +00:00
Fred Drake
8aa3bd9098
Make it clear that id() can return either a long integer or a plain integer.
2000-06-29 03:46:46 +00:00
Fred Drake
5c529d3f3e
Add a "See also:" link to the curses.ascii module.
2000-06-28 22:11:40 +00:00
Fred Drake
589f44b9d0
Made the title of the Examples subsection plural!
2000-06-28 22:09:20 +00:00
Fred Drake
be93a8332e
Added note that the atexit module was added for Python 1.6.
2000-06-28 22:07:55 +00:00
Fred Drake
6f2a5efec9
Added entry for the curses.ascii module.
2000-06-28 22:05:44 +00:00
Fred Drake
5ccd4b2a54
Added entries for the curses.ascii module.
2000-06-28 22:03:29 +00:00
Fred Drake
4e716fa0ac
Skip Montanaro <skip@mojam.com>:
...
Added an example of using an HTTP POST request.
2000-06-28 21:51:43 +00:00
Fred Drake
c82634c13c
Thomas Wouters <thomas@xs4all.net>:
...
Documentation updates related to the addition of openpty() and forkpty().
2000-06-28 17:27:48 +00:00
Fred Drake
c19425d520
Added the atexit module and documentation from Skip Montanaro
...
<skip@mojam.com>. Revisions to the markup to make it pass LaTeX, added
an index entry and a reference from the sys.exitfunc documentation.
This closes SourceForge patch #100620 .
2000-06-28 15:07:31 +00:00
Andrew M. Kuchling
af5b76677f
Changed obsolete e-mail alias
2000-06-27 03:16:04 +00:00
Andrew M. Kuchling
f57d7b9e30
Dcoumentation for ascii.py. I've changed two references from ascii to
...
curses.ascii.
2000-06-26 23:59:24 +00:00
Andrew M. Kuchling
a4ca07cc8c
Minor grammatical fix
2000-06-21 01:48:46 +00:00
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