diff options
| author | Mark Summerfield <list@qtrac.plus.com> | 2008-03-17 08:28:15 (GMT) |
|---|---|---|
| committer | Mark Summerfield <list@qtrac.plus.com> | 2008-03-17 08:28:15 (GMT) |
| commit | 43da35de7bfbdbcba26d7d4226835cc718c2de7d (patch) | |
| tree | 7716907a8d85d4a5678119a3fc94c47d61c60aba /Doc/library/xml.dom.minidom.rst | |
| parent | 91f0ee4db6540e85f61c1a3969f62b7928d67fb8 (diff) | |
| download | cpython-43da35de7bfbdbcba26d7d4226835cc718c2de7d.zip cpython-43da35de7bfbdbcba26d7d4226835cc718c2de7d.tar.gz cpython-43da35de7bfbdbcba26d7d4226835cc718c2de7d.tar.bz2 | |
Added a footnote to each pointing out that for XML output if an encoding
string is given it should conform to the appropriate XML standards---for
example, "UTF-8" is okay, but "UTF8" is not.
Diffstat (limited to 'Doc/library/xml.dom.minidom.rst')
| -rw-r--r-- | Doc/library/xml.dom.minidom.rst | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index 3f1d2a4..21b2d6c 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -141,7 +141,8 @@ module documentation. This section lists the differences between the API and support pretty output. .. versionchanged:: 2.3 - For the :class:`Document` node, an additional keyword argument *encoding* can be + For the :class:`Document` node, an additional keyword argument + *encoding* [1]_ can be used to specify the encoding field of the XML header. @@ -154,7 +155,7 @@ module documentation. This section lists the differences between the API and document. Encoding this string in an encoding other than UTF-8 is likely incorrect, since UTF-8 is the default encoding of XML. - With an explicit *encoding* argument, the result is a byte string in the + With an explicit *encoding* [1]_ argument, the result is a byte string in the specified encoding. It is recommended that this argument is always specified. To avoid :exc:`UnicodeError` exceptions in case of unrepresentable text data, the encoding argument should be specified as "utf-8". @@ -172,7 +173,7 @@ module documentation. This section lists the differences between the API and .. versionadded:: 2.1 .. versionchanged:: 2.3 - the encoding argument; see :meth:`toxml`. + the encoding [1]_ argument; see :meth:`toxml`. The following standard DOM methods have special considerations with :mod:`xml.dom.minidom`: @@ -265,3 +266,9 @@ The following interfaces have no implementation in :mod:`xml.dom.minidom`: Most of these reflect information in the XML document that is not of general utility to most DOM users. +.. rubric:: Footnotes + +.. [#] The encoding string included in XML output should conform to the + appropriate standards. For example, "UTF-8" is valid, but "UTF8" is + not. See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl + and http://www.iana.org/assignments/character-sets . |