summaryrefslogtreecommitdiff
path: root/vendor/github.com/stretchr/testify/assert/doc.go
diff options
context:
space:
mode:
authorAlex Flint <[email protected]>2018-11-20 12:00:02 -0800
committerGitHub <[email protected]>2018-11-20 12:00:02 -0800
commit6638fbbc28f9ad0136ef5fd84a15c995e08e161f (patch)
treebbe1178f8f327c88202b1343445d5d80a2b70254 /vendor/github.com/stretchr/testify/assert/doc.go
parent6ab8ad5e1c5b25ca2783fe83f493c3ab471407e2 (diff)
parent074e17cef3fd85e43623cec685fb41806b25d12e (diff)
Merge pull request #3 from alexflint/gomodv1.0.0
Create go.mod
Diffstat (limited to 'vendor/github.com/stretchr/testify/assert/doc.go')
-rw-r--r--vendor/github.com/stretchr/testify/assert/doc.go45
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