bpo-18911: clarify that the minidom XML writer receives texts but not bytes (GH-13352)
https://github.com/python/cpython/commit/5ac0b988fd5f1428efe35329c531c7b5c74... commit: 5ac0b988fd5f1428efe35329c531c7b5c74d37f6 branch: master author: Windson yang <wiwindson@outlook.com> committer: Stefan Behnel <stefan_ml@behnel.de> date: 2019-06-01T08:33:16+02:00 summary: bpo-18911: clarify that the minidom XML writer receives texts but not bytes (GH-13352) files: M Doc/library/xml.dom.minidom.rst diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index 2423a0c15691..8711242d95d7 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.
participants (1)
-
Stefan Behnel