Document the test-only intentions of this package

google · Feb 27, 2020 · 8105bcc · 8105bcc
1 parent 5a6f757
commit 8105bcc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/cmp/compare.go b/cmp/compare.go
@@ -6,6 +6,9 @@
 //
 // This package is intended to be a more powerful and safer alternative to
 // reflect.DeepEqual for comparing whether two values are semantically equal.
+// It is intended to only be used in tests, as cmp may panic if it cannot
+// compare the values. It's propensity towards panicking means that it is
+// unsuitable for production environments where a spurious panic may be fatal.
 //
 // The primary features of cmp are:
 //