Skip to content

Commit 7a1b408

Browse files
committed
doc: improve godoc of top level 'testify' package
1 parent c519b79 commit 7a1b408

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc.go

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
// Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend.
1+
// Module testify is a set of packages that provide many tools for testifying that your code will behave as you intend.
22
//
3-
// testify contains the following packages:
3+
// Testify contains the following packages:
44
//
5-
// The assert package provides a comprehensive set of assertion functions that tie in to the Go testing system.
5+
// The [github.com/stretchr/testify/assert] package provides a comprehensive set of assertion functions that tie in to [the Go testing system].
6+
// The [github.com/stretchr/testify/require] package provides the same assertions but as fatal checks.
67
//
7-
// The mock package provides a system by which it is possible to mock your objects and verify calls are happening as expected.
8+
// The [github.com/stretchr/testify/mock] package provides a system by which it is possible to mock your objects and verify calls are happening as expected.
89
//
9-
// The suite package provides a basic structure for using structs as testing suites, and methods on those structs as tests. It includes setup/teardown functionality in the way of interfaces.
10+
// The [github.com/stretchr/testify/suite] package provides a basic structure for using structs as testing suites, and methods on those structs as tests. It includes setup/teardown functionality in the way of interfaces.
1011
//
1112
// A [golangci-lint] compatible linter for testify is available called [testifylint].
1213
//
14+
// [the Go testing system]: https://go.dev/doc/code#Testing
1315
// [golangci-lint]: https://golangci-lint.run/
1416
// [testifylint]: https://github.com/Antonboom/testifylint
1517
package testify

0 commit comments

Comments
 (0)