From baf94af4dae000908425083bcc2fd20082a16e49 Mon Sep 17 00:00:00 2001 From: Pierre Gimalac Date: Sat, 22 Feb 2025 11:52:15 +0100 Subject: [PATCH] chore: update readme to mention only using in tests --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e592e3a..c2d8aa0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ 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: * When the default behavior of equality does not suit the needs of the test,