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
5e08d10dd9
Update the documentation links
...
Remove reference to this being a draft
2001-12-20 16:33:45 +00:00
adc7df5778
Use the final patch/bug numbers
2001-12-20 16:04:24 +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
b9c0ef5db7
Update to reflect recently added markup.
2001-12-15 22:24:06 +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
08d752cf28
Update to use the notice environment so a multi-paragraph note can be
...
appropriately marked.
2001-12-14 22:55:14 +00:00
591dd8f620
Update information about __del__() & reference cycles for CPython.
...
This partially fixes SF bug #492619 .
Fix a typo & use the new notice environment instead of (ab)using the \note
and \warning macros.
2001-12-14 22:52:41 +00:00
6ca33771f8
Add a new environment for whole-paragraph (or longer) notes & warnings.
2001-12-14 22:50:06 +00:00
dda7dcb3f7
Add a missing "cycle".
2001-12-14 21:19:08 +00:00
b062cb22d0
Work around the problem of spaces after a "}" being dropped by LaTeX2HTML if
...
they were represented by newlines in the document source.
Partially fixes SF bug #493243 .
2001-12-14 16:57:31 +00:00
e27f86820a
The valign attribute to control the vertical alignment of a table cell should
...
be on the <tr> element, not the <table> element.
Partially fixes SF bug #493243 .
2001-12-14 16:54:53 +00:00
e6965cd9f0
Bump version numbers for the trunk.
2001-12-14 16:45:04 +00:00
7b82271bb5
Reflect change of Digital Creations to Zope Corporation.
2001-12-14 16:42:56 +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
5f29319197
Replace the "Cookbook approach" with the approach documented in
...
PC/example_nt/readme.txt; this one does not rely on any external scripts.
This "fixes" SF bug #221671 and most of SF bug #225003 .
2001-12-13 17:20:32 +00:00
a0b767625b
Minor adjustments.
2001-12-13 04:25:37 +00:00
850d3980ab
Fix for
...
[ #429329 ] actual-parameters *arg, **kws not doc'd
2001-12-12 11:56:33 +00:00
5f443cb550
Added the iSilo documentation to the standard target for distribution files
...
for "online" (as opposed to typeset) formats.
2001-12-12 06:22:43 +00:00
8d0645cb84
Add a note about yield requiring a __future__ directive.
2001-12-12 06:06:43 +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
3a8e59ebe1
Clean up a sad sentence in the yield description.
2001-12-11 21:58:35 +00:00
e31e9cebc0
Document generators and the yield statement, avoiding implementation details.
2001-12-11 21:10:08 +00:00
be6dd3083c
Remove crufty whitespace in a block of index entries.
...
Minor, but generates slightly smaller HTML & makes it easier to see what's
happening when debugging the HTML.
2001-12-11 20:49:23 +00:00
54e6294197
A number of small adjustments.
2001-12-11 19:40:16 +00:00
145b479508
Added discussion of protecting against screwing up the exception state in
...
an object's deallocator, including an example of how to do this.
2001-12-11 19:28:22 +00:00
f582b82fe9
SF bug #491415 PyDict_UpdateFromSeq2() unused
...
PyDict_UpdateFromSeq2(): removed it.
PyDict_MergeFromSeq2(): made it public and documented it.
PyDict_Merge() docs: updated to reveal <wink> that the second
argument can be any mapping object.
2001-12-11 18:51:08 +00:00
c82bd7281f
Save a new version of the productionlist environment for safe-keeping; this
...
will be replaced shortly. See the comments for more details.
2001-12-11 18:47:36 +00:00
1d3e6c15ce
Fix whitespace in example of bad indentation: a comment indicated that one
...
line was not indented at all, so the example is no longer indented at all.
All of the errors being shown remain.
Typo: characteru --> character
2001-12-11 17:46:38 +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
73f0a4ecd7
Script to generate the table of distribution packages, plugging in the size
...
information automatically.
2001-12-08 00:26:07 +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
c6259d73c2
Another name.
2001-12-07 18:27:38 +00:00
44b3f76adf
More info about the cycle detector.
2001-12-07 17:57:56 +00:00
874c4f0f99
Trivial spelling repair on new cyclic garbage text.
2001-12-07 17:51:41 +00:00
024e647972
Added more information about reference counting limitations and the cycle
...
detector.
This closes SF bug #484950 .
2001-12-07 17:30:40 +00:00
038215ab0c
Use an immutable tuple for __slots instead of a mutable list
...
Bump version number
2001-12-07 14:22:13 +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
32a3587345
Document that PyString_FromString() cannot take NULL as a parameter.
...
This closes SF bug #489872 .
2001-12-06 20:38:15 +00:00
22d35a7337
[Bug #459270 ] Fix incorrect filename for system-wide config file
2001-12-06 16:34:53 +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
c2f496a138
Add a note to the description of the interaction between the softspace
...
attribute of file objects, the print statement, and other file operations.
This closes SF bug #484857 .
Fix minor markup nits.
2001-12-05 05:46:25 +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
4ed6be7107
Import the keyword module instead of relying on our own list of
...
reserved words. No longer need to import string.
2001-12-04 20:39:36 +00:00
41c6719fe4
Put the keywords back in alphabetical order. Apparently somebody
...
didn't use reswords.py, as the comment clearly states. :-(
2001-12-04 20:38:44 +00:00
ecd8157a2c
Include a warning that scripts should not have the same name as standard
...
modules, or the module cannot be properly imported. (Based on a suggestion
sent to python-docs.)
Update the displayed dir() of the sys and __builtin__ module with Python 2.2.
2001-12-04 19:47:46 +00:00
6016dbecca
Talk about str() in the discussion of string representations of values, and
...
give examples for which str() and repr() yield different results.
This closes SF bug #485446 .
2001-12-04 19:20:43 +00:00
bb7775a6ae
Fix SF bug #479967 : Appearantly I broke something that made the index
...
insertion work. This fix makes things at least somewhat more explicit, and
adds a little sanity checking (and verbosity!) to
add_bbl_and_idx_dummy_commands().
2001-12-04 17:03:54 +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
b48b6d0737
Remove meaningless comment.
2001-12-04 16:32:04 +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
fcf94681ed
Update lambda description to reflect nested scopes. This was noted by
...
Andrew Koenig.
2001-12-03 21:47:37 +00:00
1a76386194
Added documentation on the ScrolledText module.
2001-12-03 21:18:30 +00:00
c54fc3179f
Oops! Forgot the value parameter.
2001-12-03 20:58:29 +00:00
9455df2a5a
Add __delete__ method of properties
...
Reflow paragraph
2001-12-03 20:55:37 +00:00
1da50f6c6e
Add a scalar product to the example list comprehensions based on a suggestion
...
sent to python-docs.
2001-12-03 18:54:33 +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
551ffae30c
Clarify that the Python runtime may behave mysteriously when an exception
...
is not handled properly.
This closes SF bug #485153 .
2001-12-03 17:56:09 +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
f07125ee53
PyErr_Format() does not return a new reference; it always returns NULL.
...
This closes SF bug #488387 .
2001-12-03 16:36:43 +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
c7b78381da
Another name.
2001-12-02 15:13:35 +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
381832ead5
Drop xmllib in favor of SAX.
2001-11-30 19:30:03 +00:00
1e53fa7907
Add a couple of entries to the whitespace-cleanups table.
2001-11-30 19:25:39 +00:00
0467775715
Add description of tkCommonDialog.
2001-11-30 19:24:49 +00:00
95e33f03ba
Added two new conversion specifications.
2001-11-30 19:06:18 +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
5ed35fd149
Add a new environment in the Python docs markup: seealso*. This is similar
...
to seealso, but does not add the "See also:" header or put the content in a
box in the HTML version.
Updated the description of \seeurl to better indicate when it should be used;
the old description was written before we had \seetitle.
2001-11-30 18:09:54 +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
454af89712
Update the signature of PyFile_WriteString().
2001-11-29 22:42:59 +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
92024d1a99
Clarify the description of the creation of an owned reference from an API
...
function.
This closes SF bug #486657 .
2001-11-29 07:16:19 +00:00
99181ac64e
Add an index entry for the discussion of PyEval_CallObject().
...
This is related to SF bug #485165 .
2001-11-29 05:02:34 +00:00
ea4d2c0241
A few small changes:
...
- Change PREFIX to PREFIXES, which contains a sequence of prefix strings.
This is useful since we want to look for both Py and PY.
- Wrap a long line.
- Collect struct tags as well as typedef names. Since we generally only
use one of the other, that improves coverage.
- Make the script executable on Unix.
This could use a better approach to determine if a symbol is documented,
and could easily avoid keeping the massive string in memory. That would
take time to actually write more code, though, so we'll bail on that
for now.
2001-11-29 04:30:46 +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
beafc795df
Typo, spotted by Fredrik Lundh.
2001-11-26 21:46:53 +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
cd8474e6a2
Add documentation for the PyCell* APIs.
2001-11-26 21:29:17 +00:00
ccf04658b0
Correctly create new-style classes in the examples
...
Mention change to _PyTuple_Resize
2001-11-26 18:15:44 +00:00
560da62fc7
Rename get_referents to get_referrers. Fixes #483815 .
2001-11-24 09:24:51 +00:00
27ae311864
Avoid trailing blank lines in the output.
2001-11-19 05:28:29 +00:00
00c96aeba6
Adjust input pre-processing so that a comment on the last line does not
...
break the processor; this will do the right thing.
2001-11-19 05:27:40 +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
63c4f907a9
Another name...
2001-11-19 04:35:58 +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
ef6373a4f6
Exhibit good form in C code: always provide docstrings in method tables, and
...
always fill in all slots of table entries.
Fixed a few minor markup errors.
2001-11-17 06:50:42 +00:00
50ecc15d05
Add omitted word for clarity.
2001-11-17 06:39:18 +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
dd2487d759
Post-release bumps. Do *NOT* merge into the 2.2b2 branch.
2001-11-16 17:34:38 +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
bc1491f60f
Thanks for the Tkinter chapter, Mike!
2001-11-15 17:26:10 +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
e1d4ad3a31
Finally commit the font changes that have been live on the development site
...
for a month or more.
2001-11-14 22:35:59 +00:00
9c7a07f7a4
Bump release number & date.
2001-11-14 22:28:26 +00:00
1336e99054
Fred observes that the typo was not the only problem with this sentence.
2001-11-14 21:38:13 +00:00
4a98f70a09
typo
2001-11-14 21:32:27 +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
64cdb48c80
No need to preprocess the header files - use ctags -I flag instead to
...
remove DL_IMPORT.
2001-11-12 12:52:01 +00:00
bfeeeee851
Fix obvious typos.
2001-11-12 07:46:31 +00:00
94ead57dc3
Added version annotations, remove hard tabs.
2001-11-09 23:34:26 +00:00
89c3a22a27
Add PyObject_CheckReadBuffer(), which returns true if its argument
...
supports the single-segment readable buffer interface.
Add documentation for this and other PyObject_XXXBuffer() calls.
2001-11-09 21:59:42 +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
3988574075
Remove my name, probably bad style.
2001-11-09 17:04:43 +00:00
3e77423a64
Script to print undocumented symbols found in Python header files.
2001-11-09 16:50:35 +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
59bfe280f5
Another name!
2001-11-07 06:23:27 +00:00
Fred Drake
Andrew M. Kuchling
Michael W. Hudson
Tim Peters
Guido van Rossum
Jeremy Hylton
Martin v. Löwis
Barry Warsaw
Thomas Heller