Add example tests (#20)
diff --git a/example_test.go b/example_test.go
new file mode 100644
index 0000000..da4d914
--- /dev/null
+++ b/example_test.go
@@ -0,0 +1,72 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package multierr_test
+
+import (
+ "errors"
+ "fmt"
+
+ "go.uber.org/multierr"
+)
+
+func ExampleCombine() {
+ err := multierr.Combine(
+ errors.New("call 1 failed"),
+ nil, // successful request
+ errors.New("call 3 failed"),
+ nil, // successful request
+ errors.New("call 5 failed"),
+ )
+ fmt.Printf("%+v", err)
+ // Output:
+ // the following errors occurred:
+ // - call 1 failed
+ // - call 3 failed
+ // - call 5 failed
+}
+
+func ExampleAppend() {
+ var err error
+ err = multierr.Append(err, errors.New("call 1 failed"))
+ err = multierr.Append(err, errors.New("call 2 failed"))
+ fmt.Println(err)
+ // Output:
+ // call 1 failed; call 2 failed
+}
+
+func ExampleErrors() {
+ err := multierr.Combine(
+ nil, // successful request
+ errors.New("call 2 failed"),
+ errors.New("call 3 failed"),
+ )
+ err = multierr.Append(err, nil) // successful request
+ err = multierr.Append(err, errors.New("call 5 failed"))
+
+ errors := multierr.Errors(err)
+ for _, err := range errors {
+ fmt.Println(err)
+ }
+ // Output:
+ // call 2 failed
+ // call 3 failed
+ // call 5 failed
+}
