From 387a3738b103cba5616086a4aa0b6a35c2366407 Mon Sep 17 00:00:00 2001 From: MarvinJWendt Date: Wed, 26 Jun 2024 13:43:56 +0200 Subject: [PATCH] better docs --- README.md | 2 +- doc.go | 12 ++++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a86951d..720dfea 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ import "atomicgo.dev/assert" ``` -Package assert provides a set of assertion functions. Every assertion function returns a boolean. This package does not integrate into the testing package automatically. If you want to use this package inside unit tests, you have to check the returning boolean value and call t.Fatal\(\) if the assertion fails. +Package assert provides a set of assertion functions. Every assertion function returns a boolean. This package does not integrateinto the testing package automatically. If you want to use this package inside unit tests, you have to check the returning boolean value and call \`t.Fatal\(\)\` if the assertion fails. This library does not provide any error messages. That way the assertions can also be used in production code. diff --git a/doc.go b/doc.go index bb5a508..c4f2f07 100644 --- a/doc.go +++ b/doc.go @@ -1,10 +1,14 @@ /* Package assert provides a set of assertion functions. -Every assertion function returns a boolean. This package does not integrate into the testing package automatically. -If you want to use this package inside unit tests, you have to check the returning boolean value and call `t.Fatal()` if the assertion fails. +Every assertion function returns a boolean. +This package does not integrateinto the testing package automatically. +If you want to use this package inside unit tests, you have to check the returning boolean +value and call `t.Fatal()` if the assertion fails. -This library does not provide any error messages. That way the assertions can also be used in production code. +This library does not provide any error messages. +That way the assertions can also be used in production code. -If you want a full-featured testing framework, we recommend https://github.com/MarvinJWendt/testza (which uses this library for assertions) +If you want a full-featured testing framework, we recommend https://github.com/MarvinJWendt/testza +(which uses this library for assertions) */ package assert