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