diff options
author | Chris <ccbrown112@gmail.com> | 2017-08-08 17:40:46 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-08-08 17:40:46 -0500 |
commit | 6b741c4cea36f54b8f20c4a3e5871f00123db185 (patch) | |
tree | a10eeddd277c4eba48a27431ead816561a20f159 /vendor/github.com/stretchr/testify/require/doc.go | |
parent | c42510a7f4cf87d1dd7f7339633f06df86f25cce (diff) | |
download | chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.tar.gz chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.tar.bz2 chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.zip |
testify (#7116)
Diffstat (limited to 'vendor/github.com/stretchr/testify/require/doc.go')
-rw-r--r-- | vendor/github.com/stretchr/testify/require/doc.go | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/github.com/stretchr/testify/require/doc.go b/vendor/github.com/stretchr/testify/require/doc.go new file mode 100644 index 000000000..169de3922 --- /dev/null +++ b/vendor/github.com/stretchr/testify/require/doc.go @@ -0,0 +1,28 @@ +// Package require implements the same assertions as the `assert` package but +// stops test execution when a test fails. +// +// Example Usage +// +// The following is a complete example using require in a standard test function: +// import ( +// "testing" +// "github.com/stretchr/testify/require" +// ) +// +// func TestSomething(t *testing.T) { +// +// var a string = "Hello" +// var b string = "Hello" +// +// require.Equal(t, a, b, "The two words should be the same.") +// +// } +// +// Assertions +// +// The `require` package have same global functions as in the `assert` package, +// but instead of returning a boolean result they call `t.FailNow()`. +// +// 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 require |