about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRune Tynan <runetynan@gmail.com>2021-01-14 19:39:59 -0500
committerRune Tynan <runetynan@gmail.com>2021-01-15 12:50:05 -0500
commit31b17f513b79e7213f16c8acdcc38a5b9018d8a4 (patch)
tree6814fe51ce68c23265cb076e8d11640022c090ce
parente42c1b9c2acb218217c02ee25514b39a1b4efb62 (diff)
downloadrust-31b17f513b79e7213f16c8acdcc38a5b9018d8a4.tar.gz
rust-31b17f513b79e7213f16c8acdcc38a5b9018d8a4.zip
Add warning to compare.py about error messages
-rw-r--r--src/test/rustdoc-json/compare.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/test/rustdoc-json/compare.py b/src/test/rustdoc-json/compare.py
index b0c5b16a197..6a921266336 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