approvals / go-approval-tests

Apache License 2.0
86 stars 22 forks source link

Move examples to their own folder #24

Closed hjwk closed 3 years ago

hjwk commented 3 years ago
emilybache commented 3 years ago

Unfortunately I think you've misunderstood the point of the examples_test - they're not meant to be executable in the normal way. They're used in the documentation only. They show up on for example

https://pkg.go.dev/github.com/approvals/go-approval-tests#example-VerifyString

So although in principle it would be good to move them to their own folder I don't want to break the documentation and I'm not entirely sure how that is generated. In any case it's not necessary to use a real testable or expect these tests to pass when run.