Document the test-only intentions of this package

google · Feb 27, 2020 · eb6a5b5 · eb6a5b5
1 parent 5a6f757
commit eb6a5b5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/cmp/compare.go b/cmp/compare.go
@@ -6,6 +6,10 @@
 //
 // 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 performance is not a goal and
+// it may panic if it cannot compare the values. Its propensity towards
+// panicking means that its unsuitable for production environments where a
+// spurious panic may be fatal.
 //
 // The primary features of cmp are:
 //