summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-05-19 14:16:14 +0000
committerGeorg Brandl <georg@python.org>2010-05-19 14:16:14 +0000
commit2ee18c6ca6b739fa40dcc2b126fea5a6790aa76b (patch)
treed2e7900a0baa9f89d228ef061b7d83c0be529f28
parent6530f7a322326f65f72d1e934d71febf7f6b0f54 (diff)
downloadcpython-git-2ee18c6ca6b739fa40dcc2b126fea5a6790aa76b.tar.gz
Merged revisions 78559,78561-78562 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r78559 | andrew.kuchling | 2010-03-01 20:45:21 +0100 (Mo, 01 Mär 2010) | 1 line #7637: update discussion of minidom.unlink() and garbage collection ........ r78561 | andrew.kuchling | 2010-03-01 20:51:43 +0100 (Mo, 01 Mär 2010) | 1 line #7191: describe more details of wbits parameter ........ r78562 | andrew.kuchling | 2010-03-01 21:11:57 +0100 (Mo, 01 Mär 2010) | 1 line #7637: avoid repeated-concatenation antipattern in example ........
-rw-r--r--Doc/includes/minidom-example.py6
-rw-r--r--Doc/library/xml.dom.minidom.rst22
-rw-r--r--Doc/library/zlib.rst8
3 files changed, 15 insertions, 21 deletions
diff --git a/Doc/includes/minidom-example.py b/Doc/includes/minidom-example.py
index c30c4e08a9..4bca949f71 100644
--- a/Doc/includes/minidom-example.py
+++ b/Doc/includes/minidom-example.py
@@ -19,11 +19,11 @@ document = """\
dom = xml.dom.minidom.parseString(document)
def getText(nodelist):
- rc = ""
+ rc = []
for node in nodelist:
if node.nodeType == node.TEXT_NODE:
- rc = rc + node.data
- return rc
+ rc.append(node.data)
+ return ''.join(rc)
def handleSlideshow(slideshow):
print "<html>"
diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst
index cb49c023fa..cfde5b908a 100644
--- a/Doc/library/xml.dom.minidom.rst
+++ b/Doc/library/xml.dom.minidom.rst
@@ -85,22 +85,12 @@ document: the one that holds all others. Here is an example program::
dom3 = parseString("<myxml>Some data</myxml>")
assert dom3.documentElement.tagName == "myxml"
-When you are finished with a DOM, you should clean it up. This is necessary
-because some versions of Python do not support garbage collection of objects
-that refer to each other in a cycle. Until this restriction is removed from all
-versions of Python, it is safest to write your code as if cycles would not be
-cleaned up.
-
-The way to clean up a DOM is to call its :meth:`unlink` method::
-
- dom1.unlink()
- dom2.unlink()
- dom3.unlink()
-
-:meth:`unlink` is a :mod:`xml.dom.minidom`\ -specific extension to the DOM API.
-After calling :meth:`unlink` on a node, the node and its descendants are
-essentially useless.
-
+When you are finished with a DOM tree, you may optionally call the
+:meth:`unlink` method to encourage early cleanup of the now-unneeded
+objects. :meth:`unlink` is a :mod:`xml.dom.minidom`\ -specific
+extension to the DOM API that renders the node and its descendants are
+essentially useless. Otherwise, Python's garbage collector will
+eventually take care of the objects in the tree.
.. seealso::
diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
index 17e63f1cec..011870425f 100644
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -115,14 +115,18 @@ The available exception and functions in this module are:
Decompresses the data in *string*, returning a string containing the
uncompressed data. The *wbits* parameter controls the size of the window
- buffer. If *bufsize* is given, it is used as the initial size of the output
+ buffer, and is discussed further below.
+ If *bufsize* is given, it is used as the initial size of the output
buffer. Raises the :exc:`error` exception if any error occurs.
The absolute value of *wbits* is the base two logarithm of the size of the
history buffer (the "window size") used when compressing data. Its absolute
value should be between 8 and 15 for the most recent versions of the zlib
library, larger values resulting in better compression at the expense of greater
- memory usage. The default value is 15. When *wbits* is negative, the standard
+ memory usage. When decompressing a stream, *wbits* must not be smaller
+ than the size originally used to compress the stream; using a too-small
+ value will result in an exception. The default value is therefore the
+ highest value, 15. When *wbits* is negative, the standard
:program:`gzip` header is suppressed.
*bufsize* is the initial size of the buffer used to hold decompressed data. If