summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCaio Ariede <caio.ariede@gmail.com>2019-05-23 10:52:32 -0300
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2019-05-24 08:24:04 +0200
commit2f0dcd8238f7b1cd24063effcfb4c8f7200f41ad (patch)
tree2c98aeedc670eebeea08b5b4e156ed7dac10f61d /docs
parentefb906cbe46e0eefe58d59bc068fe5221f39ca5e (diff)
[2.2.x] Doc'd that assertXMLEqual()/assertXMLNotEqual() ignores XML declaration and comments.
Backport of 4fb9e7b057507dda1bccd969871ae350f6c68fef from master
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/testing/tools.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index e656f89124..62b37bb63b 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -1641,6 +1641,9 @@ your test suite.
syntax differences. When invalid XML is passed in any parameter, an
``AssertionError`` is always raised, even if both string are identical.
+ XML declaration and comments are ignored. Only the root element and its
+ children are compared.
+
Output in case of error can be customized with the ``msg`` argument.
.. method:: SimpleTestCase.assertXMLNotEqual(xml1, xml2, msg=None)