From 2f0dcd8238f7b1cd24063effcfb4c8f7200f41ad Mon Sep 17 00:00:00 2001
From: Caio Ariede <caio.ariede@gmail.com>
Date: Thu, 23 May 2019 10:52:32 -0300
Subject: [PATCH] [2.2.x] Doc'd that assertXMLEqual()/assertXMLNotEqual()
 ignores XML declaration and comments.

Backport of 4fb9e7b057507dda1bccd969871ae350f6c68fef from master
---
 docs/topics/testing/tools.txt | 3 +++
 1 file changed, 3 insertions(+)

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)