From bc3552076f6da93531898d05e871ed4cedc7e80b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 13 Feb 2025 23:28:26 +0100 Subject: [PATCH] Refine the caution --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ce4f63d..f22176d 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,16 @@ The generics (type parameters) make the usage type-safe. The library is [extensible](#extensibility) by design. -> In general, [avoid using assertion libraries](https://go.dev/wiki/TestComments#assert-libraries). -> Use this library if you still have a preference to use one. -> Consider using [`github.com/google/go-cmp`](https://github.com/google/go-cmp) -> and writing custom helpers instead. +> [!CAUTION] +> [Avoid using assertion libraries](https://go.dev/wiki/TestComments#assert-libraries). +> Instead, use [`go-cmp`](https://github.com/google/go-cmp) +> and write custom test helpers. +> Using the popular [`testify`](https://github.com/stretchr/testify) +> may be also an acceptable choice, +> especially together with [`testifylint`](https://github.com/Antonboom/testifylint) +> to avoid common mistakes. +> Use this library if you still want to. +> Consider yourself warned. ### Quick start