doc: cleanup and improve for recently moved pkgs (#354)

* chore(atomicx): review docs and add usage example

* chore(fsx): improve docs, return value, add examples

* fix(kvstore): correct typo and add example

* fix(multierror): add basic example

* doc: revamp ooapi documentation
This commit is contained in:
Simone Basso 2021-06-04 11:39:00 +02:00 committed by GitHub
commit acd4ffff35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 172 additions and 26 deletions

View file

@ -0,0 +1,16 @@
package multierror_test
import (
"errors"
"fmt"
"github.com/ooni/probe-cli/v3/internal/multierror"
)
func ExampleUnion() {
root := errors.New("some error")
me := multierror.New(root)
check := errors.Is(me, root)
fmt.Printf("%+v\n", check)
// Output: true
}