[2.2.x] Doc'd that assertXMLEqual()/assertXMLNotEqual() ignores XML d…

…eclaration and comments. Backport of 4fb9e7b from master
django · May 24, 2019 · 2f0dcd8 · 2f0dcd8
1 parent efb906c
commit 2f0dcd8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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)