diff options
| author | Alex Flint <[email protected]> | 2017-02-17 20:57:21 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2017-02-17 20:57:21 -0800 |
| commit | 2c249ee1fcc1d48bb2e8071c3396f7c97a383dd3 (patch) | |
| tree | ab73e8fc3d578d10e172553c2a6ddcd886b9136f /vendor/github.com/stretchr/testify/assert/doc.go | |
| parent | 765ccf745937c16486999600ecf789c646ac2e6c (diff) | |
| parent | 44a8b85d8250005629dd43d78b3e305bc57e1e24 (diff) | |
Merge pull request #46 from alexflint/vendoring
vendor in dependencies
Diffstat (limited to 'vendor/github.com/stretchr/testify/assert/doc.go')
| -rw-r--r-- | vendor/github.com/stretchr/testify/assert/doc.go | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/vendor/github.com/stretchr/testify/assert/doc.go b/vendor/github.com/stretchr/testify/assert/doc.go new file mode 100644 index 0000000..c9dccc4 --- /dev/null +++ b/vendor/github.com/stretchr/testify/assert/doc.go @@ -0,0 +1,45 @@ +// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. +// +// Example Usage +// +// The following is a complete example using assert in a standard test function: +// import ( +// "testing" +// "github.com/stretchr/testify/assert" +// ) +// +// func TestSomething(t *testing.T) { +// +// var a string = "Hello" +// var b string = "Hello" +// +// assert.Equal(t, a, b, "The two words should be the same.") +// +// } +// +// if you assert many times, use the format below: +// +// import ( +// "testing" +// "github.com/stretchr/testify/assert" +// ) +// +// func TestSomething(t *testing.T) { +// assert := assert.New(t) +// +// var a string = "Hello" +// var b string = "Hello" +// +// assert.Equal(a, b, "The two words should be the same.") +// } +// +// Assertions +// +// Assertions allow you to easily write test code, and are global funcs in the `assert` package. +// All assertion functions take, as the first argument, the `*testing.T` object provided by the +// testing framework. This allows the assertion funcs to write the failings and other details to +// the correct place. +// +// Every assertion function also takes an optional string message as the final argument, +// allowing custom error messages to be appended to the message the assertion method outputs. +package assert |
