summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-05-31 23:58:54 -0700
committerStefan Behnel <stefan_ml@behnel.de>2019-06-01 08:58:54 +0200
commit18e23f227be59241cbb1eeb6d6669771dd7275fb (patch)
tree3b2615e50af0788a527632810a03d0f3a5653399 /Doc
parent464c1ec65af2c1c1d849d50d9726fa453804e70e (diff)
downloadcpython-git-18e23f227be59241cbb1eeb6d6669771dd7275fb.tar.gz
bpo-18911: clarify that the minidom XML writer receives texts but not bytes (GH-13718)
(cherry picked from commit 5ac0b988fd5f1428efe35329c531c7b5c74d37f6) Co-authored-by: Windson yang <wiwindson@outlook.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/xml.dom.minidom.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst
index 96080c3e31..c68b0371af 100644
--- a/Doc/library/xml.dom.minidom.rst
+++ b/Doc/library/xml.dom.minidom.rst
@@ -134,11 +134,12 @@ module documentation. This section lists the differences between the API and
.. method:: Node.writexml(writer, indent="", addindent="", newl="")
- Write XML to the writer object. The writer should have a :meth:`write` method
- which matches that of the file object interface. The *indent* parameter is the
- indentation of the current node. The *addindent* parameter is the incremental
- indentation to use for subnodes of the current one. The *newl* parameter
- specifies the string to use to terminate newlines.
+ Write XML to the writer object. The writer receives texts but not bytes as input,
+ it should have a :meth:`write` method which matches that of the file object
+ interface. The *indent* parameter is the indentation of the current node.
+ The *addindent* parameter is the incremental indentation to use for subnodes
+ of the current one. The *newl* parameter specifies the string to use to
+ terminate newlines.
For the :class:`Document` node, an additional keyword argument *encoding* can
be used to specify the encoding field of the XML header.