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