Document test suite as a good root (#27)

Fixes #25
This commit is contained in:
Kirill Zaborsky 2020-04-10 15:35:17 +03:00 committed by GitHub
parent 7ed6e38174
commit 4d1ae57166
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -65,7 +65,9 @@ files have the type:
`roots` is a list of regular expressions of symbols that are considered as
alive. If you're building an executable, the pattern `^Main.main$` is a
good starting point - specifying that `main` is a root.
good starting point - specifying that `main` is a root. Weeder currently doesn't
add all exported functions a roots automatically but in many cases `main` from a
test suite could be a good workaround for that
`type-class-roots` configures whether or not Weeder should consider anything in
a type class instance as a root. Weeder is currently unable to add dependency