From a70813e6ee201bef69b3c174a41eaed55c32913d Mon Sep 17 00:00:00 2001
From: Rune Tynan <runetynan@gmail.com>
Date: Thu, 14 Jan 2021 19:39:59 -0500
Subject: [PATCH] Add warning to compare.py about error messages

---
 src/test/rustdoc-json/compare.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/test/rustdoc-json/compare.py b/src/test/rustdoc-json/compare.py
index b0c5b16a19700..6a921266336e0 100644
--- a/src/test/rustdoc-json/compare.py
+++ b/src/test/rustdoc-json/compare.py
@@ -7,6 +7,9 @@
 # and then create `yourtest.expected` by stripping unnecessary details from `yourtest.json`. If
 # you're on windows, replace `\` with `/`.
 
+# WARNING: The error messages produced by this may be misleading, in the case of list re-ordering
+#          it may point to apparently unrelated keys.
+
 import copy
 import sys
 import json