-
Notifications
You must be signed in to change notification settings - Fork 1.7k
doc: improve godoc of top level 'testify' package #1760
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+7
−5
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,17 @@ | ||
// Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend. | ||
// Module testify is a set of packages that provide many tools for testifying that your code will behave as you intend. | ||
// | ||
// testify contains the following packages: | ||
// Testify contains the following packages: | ||
// | ||
// The assert package provides a comprehensive set of assertion functions that tie in to the Go testing system. | ||
// The [github.com/stretchr/testify/assert] package provides a comprehensive set of assertion functions that tie in to [the Go testing system]. | ||
// The [github.com/stretchr/testify/require] package provides the same assertions but as fatal checks. | ||
ccoVeille marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// | ||
// The mock package provides a system by which it is possible to mock your objects and verify calls are happening as expected. | ||
// 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. | ||
// | ||
// 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. | ||
// 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. | ||
// | ||
// A [golangci-lint] compatible linter for testify is available called [testifylint]. | ||
// | ||
// [the Go testing system]: https://go.dev/doc/code#Testing | ||
// [golangci-lint]: https://golangci-lint.run/ | ||
// [testifylint]: https://github.com/Antonboom/testifylint | ||
package testify |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.