]> granicus.if.org Git - python/commitdiff
projects / python / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 6530f7a)
Merged revisions 78559,78561-78562 via svnmerge from
authorGeorg Brandl <georg@python.org>
Wed, 19 May 2010 14:16:14 +0000 (14:16 +0000)
committerGeorg Brandl <georg@python.org>
Wed, 19 May 2010 14:16:14 +0000 (14:16 +0000)
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
........

Doc/includes/minidom-example.py patch | blob | history
Doc/library/xml.dom.minidom.rst patch | blob | history
Doc/library/zlib.rst patch | blob | history

diff --git a/Doc/includes/minidom-example.py b/Doc/includes/minidom-example.py
index c30c4e08a9425b930c9d98a6edbd868245e2f4d6..4bca949f71fdbbcf7c463e8b21991df0c2606790 100644 (file)
--- 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 cb49c023fa45f162412bd0723ae7cd621308c4e4..cfde5b908a91cd089c1835ceac93bfb1e2134c11 100644 (file)
--- 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 17e63f1cecfa93edca5c13d57f7e0947688b4263..011870425f842228a4e01afa8e1a36764f6986f4 100644 (file)
--- 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
Unnamed repository; edit this file 'description' to name the repository.