3d62f8ca35
Fix a simple typo. Has this to be fixed also in other branches?
2002-01-14 08:37:39 +00:00
a55ffaeee9
Add a per-message fallback mechanism for translations.
2002-01-11 06:58:49 +00:00
1be6419871
Add fallback argument to translation(). Request fallbacks on install.
...
Fixes #500595 .
2002-01-11 06:33:28 +00:00
7731ed47cb
Do not mask the name of a built-in function in example code.
...
Based on comment sent to python-docs.
2002-01-05 04:00:03 +00:00
5e74d36f9d
Fix indentation error in example from the Tkinter Life Preserver.
...
This closes SF bug #499505 .
2002-01-05 03:56:54 +00:00
d93d68bd13
Fix minor typo reported in SF patch #497951 .
2002-01-05 01:52:41 +00:00
c33e077838
SF patch #497420 (Eduardo Pérez): ftplib: ftp anonymous password
...
Instead of sending the real user and host, use "anonymous@" (i.e. no
host name at all!) as the default anonymous FTP password. This avoids
privacy violations.
2001-12-28 20:54:28 +00:00
7c9a53dfc0
Elaborate the descriptions for onecmd(), precmd(), and postcmd() so they are
...
useful.
2001-12-27 05:10:18 +00:00
fd7f115a0e
Fix wrongly-named formal parameters in three places: begin_y was used twice
...
instead of begin_y and begin_x for derwin(), subpad(), and subwin().
Reported for derwin() by Eric Huss.
Added class annotations for the window methods so they would be properly
described in the index.
2001-12-26 22:08:44 +00:00
ab2dc1d730
Added index entries similar to some recommended by Skip, and used the word
...
"interpolation" in the text, to make the string formatting material easier to
find.
This closes SF bug #487165 .
Bugfix: this should be applied for Python 2.2.1.
2001-12-26 20:06:40 +00:00
ef338ec5f9
More index entries.
2001-12-26 19:48:43 +00:00
39960f6ec9
Fix the erroneous availability annotation for s.makefile() from the last
...
checkin (my fault!).
Wrap some long lines and fix some markup inconsistencies.
2001-12-22 19:07:58 +00:00
87fa3aa12c
Add notes that fromfd() and s.makefile() are Unix-specific.
...
This fixes SF bug #495896 .
Fix up various markup consistency & style guide conformance nits.
2001-12-21 17:45:03 +00:00
5c7983113c
Add a reference to the signal module to the os.kill() description.
...
This closes SF bug #495609 .
2001-12-21 03:58:47 +00:00
dce2e1161a
Fix typo in httplib example.
...
This fixes SF bug #495221 .
2001-12-21 03:52:04 +00:00
8c8e871530
Fix the availability statement for the spawn*() functions to reflect the
...
actual availability on Windows.
This fixes SF bug #495191 .
2001-12-20 17:24:11 +00:00
34a37b807a
Re-commit Ping's patch to the cgi and cgitb documentation, using the
...
right version this time. Thanks, Ping!
(This was from SF patch #494582 , "\index -> \indexii" version.)
2001-12-20 17:13:09 +00:00
4b1b3bfac1
Add entry for the pydoc documentation.
2001-12-18 16:32:30 +00:00
96be564027
Add documentation for the pydoc module; contributed by Ka-Ping Yee.
...
This closes SF patch #494622 .
2001-12-18 16:31:44 +00:00
732299ff63
Add documentation for the help() built-in; contributed by Ka-Ping Yee.
...
This is part of SF patch #494622 .
2001-12-18 16:31:08 +00:00
e088970ce0
Merge in Ping's changes to the cgitb documentation, and add a version
...
annotation as well.
This closes SF patch #494582 .
2001-12-18 15:51:55 +00:00
0c0b5305ae
Mark the mpz module deprecated as of Python 2.2.
2001-12-16 01:54:55 +00:00
c57772870b
Add a link to the mxNumber package.
2001-12-15 20:37:40 +00:00
b40501b05e
Add link to the gmpy project.
2001-12-15 18:37:24 +00:00
dda7dcb3f7
Add a missing "cycle".
2001-12-14 21:19:08 +00:00
526c7a0101
Ensure that complex() only accepts a string argument as the first arg,
...
and only if there is no second arg.
This closes SF patch #479551 .
2001-12-13 19:52:22 +00:00
a0b767625b
Minor adjustments.
2001-12-13 04:25:37 +00:00
1529ef860e
Document that isleap() returns exactly 1 or 0, which is guaranteed by the
...
docstring.
This closes SF bug #485794 .
Additional (very) small details were added.
2001-12-12 05:40:46 +00:00
cf72abab8c
Update link to the SAX homepage.
2001-12-10 18:10:37 +00:00
6048ce95a9
Added documentation for str.decode().
...
This closes SF bug #490823 .
2001-12-10 16:43:08 +00:00
146483964e
Patch supplied by Burton Radons for his own SF bug #487390 : Modifying
...
type.__module__ behavior.
This adds the module name and a dot in front of the type name in every
type object initializer, except for built-in types (and those that
already had this). Note that it touches lots of Mac modules -- I have
no way to test these but the changes look right. Apologies if they're
not. This also touches the weakref docs, which contains a sample type
object initializer. It also touches the mmap test output, because the
mmap type's repr is included in that output. It touches object.h to
put the correct description in a comment.
2001-12-08 18:02:58 +00:00
f9d580346b
Add change notes where im_class is discussed, since the exact meaning changes
...
with Python 2.2.
2001-12-07 23:13:53 +00:00
b62f0e1a7b
Correct the description of im_class. (Fred, this is changed in 2.2.
...
Should this be labeled as changed? How?)
2001-12-07 22:03:18 +00:00
7961930595
Revise description of dumbdbm.open() to reflect that the flag argument is
...
ignored and that mode was ignored before Python 2.2.
This closes SF bug #490098 .
2001-12-07 21:56:13 +00:00
8b7bb7a0f2
Describe the behavior of the read() method when the list of filenames
...
includes files that do not exist, explain the intended use of the interface,
and show how to ensure an expected file really exists.
This closes SF bug #490399 .
2001-12-07 21:35:57 +00:00
b404145936
s/it/if/ in descriptions of spawn mode argument.
2001-12-06 23:37:17 +00:00
c7cb69263d
For ratecv, document that None should be the initial state argument (when
...
I was squashing spurious overflows in the implementation, I got hung up
on this point).
2001-12-06 23:16:09 +00:00
a16433b14e
Re-enabled debugging prints in poplib & documented the set_debuglevel()
...
method.
This closes SF patch #486079 .
2001-12-05 22:37:21 +00:00
d761662b66
asyncore.loop() description contributed by Skip Montanaro.
...
This closes SF bug #489513 .
2001-12-05 21:37:50 +00:00
39368c1053
Added documentation of the sendall() method, and a note to the send() method
...
that it does not guarantee that all data is sent.
This closes SF patch #474307 .
2001-12-05 05:25:59 +00:00
d2a557e51e
Added entry for the "cgitb" module docs.
2001-12-04 22:48:17 +00:00
6e70e8b401
Documentation for the "cgitb" module.
2001-12-04 22:47:42 +00:00
97e3201220
Add a note that the rgbimg module is only built on 32-bit machines (prompted
...
by a question to webmaster).
Re-wrapped a long line.
2001-12-04 16:49:00 +00:00
db5a93cd6a
Update docs to reflect new compile() and compileFile()
2001-12-04 02:48:52 +00:00
b38784e4a0
Slightly improved indexing for the string-% operator, thanks to comments
...
from Skip Montanaro. There is one weirdness in the final index for HTML, but
that is low priority.
2001-12-03 22:15:56 +00:00
1a76386194
Added documentation on the ScrolledText module.
2001-12-03 21:18:30 +00:00
5172adca81
Minor clarification of the zip() description, based on a comment sent to
...
python-docs.
2001-12-03 18:35:05 +00:00
14f5c5fa01
Make no assumption about how modules are built when referring to them; this
...
can vary by platform and installation.
Based on suggestion to python-docs.
2001-12-03 18:33:13 +00:00
1722e4a952
Re-word the intro slightly to avoid reader misunderstanding: strings are not
...
mutable! We do not want to shock anyone.
This closes SF bug #483805 .
Re-factor so that the description of the "access" keyword parameter is not
repeated in both the descriptions of mmap(). Also, only make sure the first
description of mmap() appears in the index. The the index link is followed,
the first is now used to locate the page on the screen; chances are really good
both will be visible. This avoids the problem that the index entry for the
second is selected and the first version is not visible, making the reader
consider that mmap() is not available on Windows.
2001-12-03 18:27:22 +00:00
3570551d6f
Remove most references to __members__ and __methods__, leaving only one pair
...
of references that now state that these attributes have been removed,
directing the reader to the dir() function.
This closes SF bug #456420 .
2001-12-03 17:32:27 +00:00
b22c6720aa
Clean up some material that is not part of the standard documentation.
...
This closes SF bug #487308 .
2001-12-03 06:12:23 +00:00
d745b4e7a4
Add reference to the "String Methods" section to make that information
...
easier to find. Based on the comment from Steve Alexander on the
zope-coders mailing list.
2001-12-02 15:10:46 +00:00
0467775715
Add description of tkCommonDialog.
2001-11-30 19:24:49 +00:00
10cd315963
Change the chapter title to reflect the Tk affinity.
...
Use the new seealso* environment in the section pointing out other GUI
toolkits.
2001-11-30 18:17:24 +00:00
89d63cc450
Minor adjustments to markup for the getDOMImplementation() description.
2001-11-30 16:58:15 +00:00
bd34b6bc3d
Added the convenience constants that are present in PyXML to make these
...
more similar.
2001-11-30 15:37:33 +00:00
38f3b72f9f
Updated documentation for the new httplib interface, by Kalle Svensson.
...
This closes SF bug #458447 .
2001-11-30 06:06:40 +00:00
44b6f84e56
More information about Tix support, contributed by Mike Clarkson.
2001-11-29 21:09:08 +00:00
6995bb61b6
Various cleanups & markup fixes, mostly relating to the stat and statvfs
...
result object changes.
2001-11-29 20:48:44 +00:00
ed0a71911c
Neil Schemenauer suggested a small improvement to one of the example REs.
2001-11-29 20:23:14 +00:00
389aa17ad3
writeline() --> writelines()
...
This closes SF bug #487147 .
2001-11-29 19:04:50 +00:00
1cec7fab1d
New section of regular expression examples contributed by Skip Montanaro,
...
with some extensions and changes from me.
This closes SF patch #472825 .
2001-11-29 08:45:22 +00:00
5107b4cf5f
Re-arrange the modules in the "Internet Data Handling" chapter to try to
...
achieve a more sensible organization.
2001-11-28 07:50:45 +00:00
6a6bb1828b
Clarify that on some systems, lockf() using LOCK_EX requires that the file
...
is opened for writing; this closes SF bug #485342 .
Added notes that file objects are also accepted in the place of file
descriptors.
2001-11-28 07:48:32 +00:00
48704ee478
Add synopsis for the SimpleXMLRPCServer module; used in the chapter-level
...
list of modules.
2001-11-28 07:32:53 +00:00
c37b65ee10
Clean up some markup cruft. A number of the macros that take no
...
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group. These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
b03d0cc45e
Typo, spotted by Detlef Lannert.
2001-11-26 21:39:40 +00:00
fcb05ab512
Tk-related modules should no longer be listed here.
2001-11-26 21:38:50 +00:00
2744f43f71
Fix typo, extra markup constructs.
...
This closes SF bug #485252 .
2001-11-26 21:30:36 +00:00
560da62fc7
Rename get_referents to get_referrers. Fixes #483815 .
2001-11-24 09:24:51 +00:00
e70dbe0fc5
Update the platform notes for the CGIHTTPServer module; it works on more
...
platforms now, and has since Python 2.0.
This closes SF bug #482943 .
2001-11-19 05:16:35 +00:00
7064d3b581
Fix the default value for feature_namespaces, per discussions on the XML-SIG
...
mailing list. This causes the docs to match the default implementation.
2001-11-19 04:34:50 +00:00
69ab5836ae
Paul Rubin reminds me that of course a class's constructor /could/ get
...
called, if the pickler found a __getinitargs__() method.
2001-11-18 16:24:01 +00:00
ebbd14d7c2
Clarified a couple of issues for the startElement*() handlers:
...
- the attrs value may be re-used by the parser, so the implementation
cannot rely on owning the object.
- an element with no namespace encountered in namespace mode will have a URI
of None, not "" (startElementNS() only).
Fixed a couple of minor markup issues as well.
2001-11-18 04:58:28 +00:00
af0a883041
Relatively large expansion of the docs for gc.garbage.
2001-11-18 04:51:17 +00:00
0c0565dd7f
Toughen up the security warnings a bit.
2001-11-16 22:28:17 +00:00
5e17d20743
Add a clarification that the email package always deals in native line
...
endings, and that it is smtplib's job to convert those to RFC 2821
line endings when sending the message.
2001-11-16 22:16:04 +00:00
666ca80b63
Clean up some markup a little bit more. Make this work with the PDF format,
...
which is a little more strict than the other formats on some things (fixable,
but not tonight).
2001-11-16 06:02:55 +00:00
5545219bf6
Document the urlsplit() and urlunsplit() functions.
2001-11-16 03:22:15 +00:00
c66ff203bb
Switched a couple of sections around.
...
Cleaned up some markup nits.
Add a few more of the Tk-related modules to the list of modules.
2001-11-16 01:05:27 +00:00
69b2d75fc7
A few minor updates to make it clear(er) that pickle should be used
...
instead of marshal for object serialization.
Fred, please proofread!
2001-11-15 23:55:12 +00:00
f595fd975d
A massive rewrite affecting both the pickle and cPickle module
...
documentation. This addresses previously undocumented parts of the
public interfaces, the differences between pickle and cPickle,
security concerns, and on and on.
Fred please proofread!
2001-11-15 23:39:07 +00:00
d44e7ad702
Minor updates to add more pointers to the pickle documentation, and to
...
clarify some of the interface.
2001-11-15 23:37:26 +00:00
fd4f069b12
The turtle docs will be moving to another location in the Tkinter chapter.
2001-11-15 22:10:46 +00:00
482b9a8c0c
Clean up the descriptions of multi-signature functions so we do the right
...
thing in the index.
2001-11-15 20:41:03 +00:00
53556861df
Add entries for the new Tkinter chapter.
2001-11-15 17:25:29 +00:00
7cf4e5b329
Tkinter chapter, contributed by Mike Clarkson. Based in part on the "Tkinter
...
Life Preserver" by Matt Conway.
2001-11-15 17:22:04 +00:00
5ebfd36afa
CVS patch #477161 : New "access" keyword for mmap, from Jay T Miller.
...
This gives mmap() on Windows the ability to create read-only, write-
through and copy-on-write mmaps. A new keyword argument is introduced
because the mmap() signatures diverged between Windows and Unix, so
while they (now) both support this functionality, there wasn't a way to
spell it in a common way without introducing a new spelling gimmick.
The old spellings are still accepted, so there isn't a backward-
compatibility issue here.
2001-11-13 23:11:19 +00:00
da4ffeecf5
No need to have documentation for a module which not accepted in the library.
2001-11-09 21:45:55 +00:00
3b0c82a2f1
Updated the documentation for formatdate().
2001-11-09 17:08:13 +00:00
30bd666c35
Cleaned up some markup stupidity and a usage problem reported by Detlef
...
Lannert. Added descriptions of HTTP_PORT and HTTPS_PORT.
2001-11-09 05:03:05 +00:00
399bc8c281
Fix a variety of typographical, grammatical, and clarity problems reported
...
by Detlef Lannert.
2001-11-09 03:49:29 +00:00
0b66310476
When referring to a formal parameter from the description, use the name given
...
with the signature, not an ad hoc abbreviated form.
2001-11-07 06:28:47 +00:00
66ded524ba
apply() documentation: Remove a detail about the implementation that does
...
not affect the API. Clean up the text about call syntax apply() is
equivalent to. Based on comments by Thomas Guettler.
2001-11-07 06:22:25 +00:00
1a670c8414
Adjust the module synopsis to avoid margin overruns in the PDF format.
2001-11-06 22:14:35 +00:00
10b81ce4e5
A variety of small cleanups, including one to avoid a margin overrun in the
...
PDF version.
2001-11-06 22:13:19 +00:00
5976816698
Remove stray quotes; probably left over from conversion from docstrings.
2001-11-06 22:11:34 +00:00
806d332f02
Remove extra period.
2001-11-06 22:10:47 +00:00
1f774b062e
Update obsolete e-mail address, and remove myself as a module author
2001-11-05 21:34:36 +00:00
4794f0b234
Update obsolete e-mail address
2001-11-05 21:31:33 +00:00
47ccfe2d8f
Remove obsolete e-mail address
2001-11-05 21:31:15 +00:00
f010df4ee5
Update URL, and remove e-mail address reference (readers can get it from
...
the Web page)
2001-11-05 21:30:10 +00:00
2bb077f630
Finally fleshed out the examples section with 4 code samples! Some of
...
my own doing, some originally written by Matthew Dixon Cowles.
2001-11-05 17:50:53 +00:00
c44403995e
Remove email*.tex subsections; they're all \input by email.tex
2001-11-05 01:55:43 +00:00
43dc1fc926
Minor grammar and typo fixes
2001-11-05 01:55:03 +00:00
169ded0d68
Finish SF patch 477059: __del__ on new classes vs. GC.
...
Just doc and NEWS here, about the change in gc.garbage meaning.
2001-11-03 19:57:21 +00:00
7533587d43
Improved error msg when a symbolic group name is redefined. Added docs
...
and NEWS. Bugfix candidate? That's a dilemma for Anthony <wink>: /F
did fix a longstanding bug here, but the fix can cause code to raise an
exception that previously worked by accident.
2001-11-03 19:35:43 +00:00
bc4a1c2588
[Patch #476612 ] Change docs to describe PEP247 interface
2001-11-02 21:44:09 +00:00
d9272d6f11
Add deprecation notice to statcache.
2001-11-02 20:20:19 +00:00
67bd68392c
Make sure there are no weird nesting behaviors; the PDF version will not
...
format if there are (building the "bookmarks" for the reader breaks).
2001-11-02 19:41:23 +00:00
99de218cfc
Promote file objects out of the "Other Objects" category, so they become
...
visible in the table of contents.
2001-10-30 06:23:14 +00:00
b4ea9d0502
Promote built-in functions to come before built-in types.
2001-10-30 06:22:02 +00:00
003047a5f2
Mention the new file() builtin in the section on file objects.
2001-10-30 05:54:04 +00:00
a427a2b8d0
Rename "dictionary" (type and constructor) to "dict".
2001-10-29 22:25:45 +00:00
589abb7212
Add additional information on exceptions from time.mktime() and related to
...
improper time tuples passed to various functions. Based on comments from
Andreas Jung.
2001-10-29 18:01:24 +00:00
e21e2bb121
Fix up a number of small problems with the DOM documentation.
...
There's still a lot to do, but it's better now.
2001-10-26 20:09:49 +00:00
41cf5e0069
Remove unused variable.
2001-10-26 19:50:26 +00:00
ef428a292a
Explain what [].insert() does when the target index is negative.
2001-10-26 18:57:14 +00:00
d5be3b75dd
Add notes pointing out that these classes are kept for backward compatibility
...
and suggeest that new code that does not require compatibility with older
Python versions subclass dictionary, list, or str.
2001-10-26 18:37:27 +00:00
7408da54e2
Many, many small fixes and improvements, most suggested by Detlef Lannert.
2001-10-26 17:40:22 +00:00
ef7d08a661
Some style changes and typo fixes.
2001-10-26 15:04:33 +00:00
de3d060eb2
Typo: destuction --> destruction
...
Reported by Thomas Heller.
2001-10-26 11:27:54 +00:00
1fc240e851
Generalize dictionary() to accept a sequence of 2-sequences. At the
...
outer level, the iterator protocol is used for memory-efficiency (the
outer sequence may be very large if fully materialized); at the inner
level, PySequence_Fast() is used for time-efficiency (these should
always be sequences of length 2).
dictobject.c, new functions PyDict_{Merge,Update}FromSeq2. These are
wholly analogous to PyDict_{Merge,Update}, but process a sequence-of-2-
sequences argument instead of a mapping object. For now, I left these
functions file static, so no corresponding doc changes. It's tempting
to change dict.update() to allow a sequence-of-2-seqs argument too.
Also changed the name of dictionary's keyword argument from "mapping"
to "x". Got a better name? "mapping_or_sequence_of_pairs" isn't
attractive, although more so than "mosop" <wink>.
abstract.h, abstract.tex: Added new PySequence_Fast_GET_SIZE function,
much faster than going thru the all-purpose PySequence_Size.
libfuncs.tex:
- Document dictionary().
- Fiddle tuple() and list() to admit that their argument is optional.
- The long-winded repetitions of "a sequence, a container that supports
iteration, or an iterator object" is getting to be a PITA. Many
months ago I suggested factoring this out into "iterable object",
where the definition of that could include being explicit about
generators too (as is, I'm not sure a reader outside of PythonLabs
could guess that "an iterator object" includes a generator call).
- Please check my curly braces -- I'm going blind <0.9 wink>.
abstract.c, PySequence_Tuple(): When PyObject_GetIter() fails, leave
its error msg alone now (the msg it produces has improved since
PySequence_Tuple was generalized to accept iterable objects, and
PySequence_Tuple was also stomping on the msg in cases it shouldn't
have even before PyObject_GetIter grew a better msg).
2001-10-26 05:06:50 +00:00
7f10cce4c1
Enforce a bit of markup consistency.
...
When describing a Boolean return value, use "true" and "false" instead of
"1" and "0".
Style-guide conformance: no "iff" -- to obscure for many readers. ;-(
2001-10-26 03:04:23 +00:00
3a2c462436
Minor textual adjustment, and style-guide conformance (no use of "iff").
2001-10-26 03:00:39 +00:00
107771a228
Applying proposed patch for bug #474583 , optional support for
...
non-standard but common types. Including Martin's suggestion to add
rejected non-standard types from patch #438790 . Specifically,
guess_type(), guess_extension(): Both the functions and the methods
grow an optional "strict" flag, defaulting to true, which determines
whether to recognize non-standard, but commonly found types or not.
Also, I sorted, reformatted, and culled duplicates from the big
types_map dictionary. Note that there are a few non-equivalent
duplicates (e.g. .cdf and .xls) for which the first will just get
thrown away. I didn't remove those though.
Finally, use of the module as a script as grown the -l and -e options
to toggle strictness and to do guess_extension(), respectively.
Doc and unittest updates too.
2001-10-25 21:49:18 +00:00
61f794918f
Typo: NamedNodeList --> NamedNodeMap
2001-10-25 20:42:57 +00:00
bc006af3d0
Make the deprecation notice use the same form as other such notices.
...
This has sat around in a deprecated state for a *long* time!
2001-10-24 21:56:59 +00:00
0559d95fd6
Minor revision of the text.
2001-10-24 21:10:52 +00:00
98791affc8
Doc and NEWS changes due to Jeremy adding traceback objects to gc.
2001-10-23 01:59:54 +00:00
d05e051aa7
Fixed an example in the use of email.Utils.getaddresses(). The
...
failobj has to be a list or the `+' can fail.
2001-10-22 20:53:45 +00:00
5d9a6b575c
Clarify that the resource module does not attempt to mask platform
...
differences by defining symbols not defined on particular platforms.
This closes SF bug #473433 .
2001-10-22 14:18:23 +00:00
9dbc0bcf9d
Update description of border()
2001-10-20 16:07:41 +00:00
0aa811c527
Use the \note and \warning macros where appropriate.
2001-10-20 04:24:09 +00:00
aad8bb5d7a
When stating that some parameters to makefile() are similar to the open()
...
parameters, given a hyperlink to the right part of the documentation to
make it easier to look those up. Also, refer to the file() function/
constructor instead of open() now that that is where the actual docs for
those parameters live.
This closes SF bug #472004 .
2001-10-19 17:22:29 +00:00
b5507ecd3c
Additional test and documentation for the unicode() changes.
...
This patch should also be applied to the 2.2b1 trunk.
2001-10-19 12:02:29 +00:00
e736d93eab
Added a note about the somewhat kludgey behavior of the message
...
epilogue, based on the discussion in this SF bug report:
https://sourceforge.net/tracker/index.php?func=detail&aid=472481&group_id=25568&atid=384678
2001-10-19 04:34:42 +00:00
b6c1d5239c
SF patch #443759 : Add Interface to readline's add_history
...
This was submitted by Moshe, but apparently he's too busy to check it
in himself. He wrote:
Here is a function in GNU readline called add_history,
which is used to manage the history list. Though Python
uses this function internally, it does not expose it to
the Python programmer. This patch adds direct interface
to this function with documentation.
This could be used by friendly modules to "seed" the
history with commands.
2001-10-19 01:18:43 +00:00
a5e616510e
changed misleading argument name
2001-10-18 20:58:25 +00:00
91b81c4802
Some minor clarifications for find()'s arguments based on SF bug
...
#463572 . Closing.
2001-10-18 19:41:48 +00:00
db7287c0f5
Straighten out the exec*() function descriptions a bit, and clarify a few
...
points in the spawn*() description.
2001-10-18 18:58:30 +00:00
ca836f7e65
Function descriptions must end as well as start!
2001-10-18 14:26:08 +00:00
c405133fce
Elaborate on types and meaning of the setgroups arguments.
2001-10-18 14:07:12 +00:00
61c5edf6fc
Expose setgroups. Fixes feature request #468116 .
2001-10-18 04:06:00 +00:00
61acf067ac
SF bug [ #471111 ] inspect.getframeinfo() needs docs.
...
TeX-ified its docstring.
2001-10-16 23:01:06 +00:00
3c28863e08
Partial patch from SF #452266 , by Jason Petrone.
...
This changes Pythread_start_thread() to return the thread ID, or -1
for an error. (It's technically an incompatible API change, but I
doubt anyone calls it.)
2001-10-16 21:13:49 +00:00
511e2cacc4
[ #403753 ] zlib decompress; uncontrollable memory usage
...
Mostly by Toby Dickenson and Titus Brown.
Add an optional argument to a decompression object's decompress()
method. The argument specifies the maximum length of the return
value. If the uncompressed data exceeds this length, the excess data
is stored as the unconsumed_tail attribute. (Not to be confused with
unused_data, which is a separate issue.)
Difference from SF patch: Default value for unconsumed_tail is ""
rather than None. It's simpler if the attribute is always a string.
2001-10-16 20:39:49 +00:00
ab9b238ced
Fix a few usage and style-guide conformance issues.
2001-10-16 19:22:51 +00:00
64d7863797
Added information about setprofile() and settrace() hooks being thread-
...
specific, and updated some of the comments about the profile hook.
This closes SF bug #471725 .
2001-10-16 14:54:22 +00:00
327798ca4a
Added notes to clarify that binascii.crc32(), zlib.crc32(), and
...
zlib.adler32() are not suitable as general hash functions.
2001-10-15 13:45:49 +00:00
cb43c085e2
Document that keyfile and certfile are now optional.
...
XXX Forgot to mention this in the last socketmodule.c checkin.
2001-10-11 16:17:22 +00:00
c7f8b86307
Describe the HeaderParser class.
2001-10-11 15:45:05 +00:00
8cd015c701
A copy-and-paste job forget the "paste" half.
2001-10-09 20:54:23 +00:00
659a60311d
Allow the profiler's calibration constant to be specified in the constructor
...
call, or via setting an instance or class vrbl.
Rewrote the calibration docs.
Modern boxes are so friggin' fast, and a profiler event does so much work
anyway, that the cost of looking up an instance vrbl (the bias constant)
per profile event just isn't a big deal.
2001-10-09 20:51:19 +00:00
dca939899d
Fix minor cut-and-paste typo.
2001-10-09 19:37:51 +00:00
e0063d20a7
Update the documentation for the isinstance() function to reflect recent
...
changes in the implementation.
Indented all descriptions consistently.
2001-10-09 19:31:08 +00:00
a55d132f08
Add documentation for the MIMEAudio class/module, contributed by
...
Anthony Baxter.
2001-10-09 19:14:17 +00:00
938a8d723c
Improve the documentation for the os.P_* constants used with the os.spawn*()
...
functions to include information about how they affect the operation of
those functions when used as the "mode" parameter.
This closes SF bug #468384 .
Added warnings to the os.tempnam() and os.tmpnam() functions regarding their
security problem. These warning mirror the warnings added to the runtime
by Skip Montanaro.
2001-10-09 18:07:04 +00:00
6959a2fcd7
Note that the values for Boolean options are case-insensitive.
2001-10-09 14:58:24 +00:00
b35f0ce2b8
Update the description of getboolean() to reflect the changes made by
...
SF patch #467580 .
2001-10-08 16:03:20 +00:00
0a1fc4e389
Remove code and docs for the OldProfile and HotProfile classes: code
...
hasn't worked in years, docs were wrong, and they aren't interesting
anymore regardless.
2001-10-07 03:12:08 +00:00
8c2c3d301b
Update the documentation to reflect the changes to ReferenceError.
2001-10-06 06:10:54 +00:00
9835206268
A regexp example was rendered as
...
foo\d
when it was clearly intended to render as
foo$
Fred, is this a right way to fix it? If not, the earlier place in the
same paragraph that does render as
foo$
is also wrong.
2001-10-05 20:06:47 +00:00
244edc8985
Add chroot call. Implements feature #459267 .
2001-10-04 22:44:26 +00:00
fcc16330a4
Update a couple of old addresses that point to CNRI.
2001-10-04 20:40:07 +00:00
3899d74c10
Make clear that tuple() accepts the same kind of arguments as list().
2001-10-04 06:53:20 +00:00
0481d24dd5
CVS patch [ #466628 ] Doc changes for doctest patch ( #466616 ), from
...
Tim Hochberg. Doctest no longer searches imported objects.
2001-10-02 21:01:22 +00:00
d90f509b8f
Fredrik tells me the truefalse parameter for boolean() is not part of the
...
public interface, so we can simplify the documentation.
2001-10-01 21:05:30 +00:00
6c81e2a44f
"boolean" --> "Boolean" (per the style guide).
2001-10-01 17:04:10 +00:00
fe95e65668
Straighten out some markup.
...
"boolean" --> "Boolean" (per the style guide).
2001-10-01 17:03:48 +00:00
e9ba525c2b
Clarify comments about mailbox objects being iterable.
2001-10-01 15:49:56 +00:00
e7877df595
Docs for SF patch #462628
2001-10-01 13:50:15 +00:00
0daad598d0
Patch #462122 : add readline startup and pre_event hooks.
2001-09-30 21:09:59 +00:00
16dc7f44b1
Patch #462190 , patch #464070 : Support quoted printable in the binascii module.
...
Decode and encode underscores for header style encoding. Fixes bug #463996 .
2001-09-30 20:32:11 +00:00
af5910f025
The execfile() docs imply it acts on locals same as exec. But in truth
...
it acts more like assigning to keys in locals(), i.e. modifications to
function locals aren't reflected in the locals when execfile() returns.
2001-09-30 06:32:59 +00:00
1c33daf143
Correct docs for long(float).
2001-09-30 06:18:26 +00:00
0d68246f01
Fix two typos in the text about compile(), and add two caveats from
...
recent user feedback: you must end the input with \n and you must use
\n, not \r\n to represent line endings.
2001-09-29 14:28:52 +00:00
a1c3662e84
forgot to mark use of StringType and UnicodeType in the text.
2001-09-29 13:53:21 +00:00
c7ba0c4c24
added description of StringTypes object
2001-09-29 13:49:41 +00:00
2b05ca3454
Minor markup improvement.
2001-09-29 05:01:59 +00:00
599db7de63
The list.sort() docs require a function that returns -1, 0 or +1. That's
...
never been true, and in particular implies cmp() can't be used(!). Get
closer to the truth.
2001-09-29 01:08:19 +00:00
7988e0249c
Move XML-RPC-related docs to the "Internet Protocols" chapter.
...
Add entry for the SimpleXMLRPCServer module.
2001-09-28 22:03:40 +00:00
e486e0d066
Preliminary documentation for the SimpleXMLRPCServer module.
2001-09-28 22:02:21 +00:00
3c10c68c0e
Use consistent version annotations instead of something ad hoc.
2001-09-28 16:57:16 +00:00
bbf7a407e8
Added note about non-support of UNC paths on Windows.
...
This fixes SF bug #465447 .
2001-09-28 16:14:18 +00:00
b387860c70
State that encode() and encodestring() append a newline to the input data
...
if it does not already end with a newline.
This fixes SF bug #463330 .
2001-09-28 16:01:46 +00:00
33f4d6d1db
Add entries for the email and compiler packages.
2001-09-27 20:11:07 +00:00
90e687863b
Markup adjustments.
2001-09-27 20:09:39 +00:00
e2f9917f9f
Migrate the compiler documentation from the Tools/compiler/doc/ directory.
...
Changes made to make it work in the new location.
2001-09-27 20:06:07 +00:00
3fc291a1d7
Fix some markup errors.
2001-09-27 04:17:20 +00:00
b802a1e7fa
Markup adjustment: \[...\] is math markup and does not translate well when
...
used with text as was done here. Fixed so that the typeset version wraps
the warning text and the HTML version does not create images of the warning
text.
2001-09-27 04:16:27 +00:00
c5f8fe3a27
Updates do email package documentation for markup, style, and
...
organization.
2001-09-26 22:21:52 +00:00
a6a885b6aa
Start making some markup adjustments; Barry has indicated he will work on
...
this before we finish the integration, along with some restructuring.
2001-09-26 16:52:18 +00:00
5e634638e6
The email package documentation, currently organized the way I think
...
Fred prefers. I'm not sure I like this organization, so it may change.
2001-09-26 05:23:47 +00:00
5055545fc0
Clarified some points about the interface to the mmap() function.
...
This closes SF bug #448918 .
2001-09-25 19:00:08 +00:00
c0765c2381
Minor changes.
2001-09-25 16:32:02 +00:00
c825280ea5
Revise the example to be more resiliant in the face of continued use after
...
the object has been pickled; don't mutate the instance dict in the
__getstate__() method. Other minor changes for style. Broke up the
displayed interactive session to get better page-breaking behavior for
typeset versions, and to point out an important aspect of the example.
This closes SF bug #453914 .
2001-09-25 16:29:17 +00:00
9081bb1d21
Added documentation for the SSL interface, contributed by Gerhard Häring.
...
This closes SF patch #461337 .
2001-09-25 15:48:11 +00:00
2c9aa5ea8d
Generalize file.writelines() to allow iterable objects.
2001-09-23 04:06:05 +00:00
8a9c284437
Make difflib.ndiff() and difflib.Differ.compare() generators. This
...
restores the 2.1 ability of Tools/scripts/ndiff.py to start producing
output before the entire comparison is complete.
2001-09-22 21:30:22 +00:00
Thomas Heller
Martin v. Löwis
Fred Drake
Guido van Rossum
Tim Peters
Jeremy Hylton
Barry Warsaw
Andrew M. Kuchling
Marc-André Lemburg
Fredrik Lundh
Skip Montanaro