Skip to content

Commit

Permalink
better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Jun 27, 2024
1 parent 267b3e1 commit 506f998
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 8 additions & 4 deletions doc.go
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 506f998

Please sign in to comment.