haskell-graphql / graphql-api

Write type-safe GraphQL services in Haskell
BSD 3-Clause "New" or "Revised" License
406 stars 35 forks source link

Resolver lacks user-facing documentation #94

Open jml opened 7 years ago

jml commented 7 years ago

According to https://github.com/jml/graphql-api/pull/92#discussion_r98338377, and because it's not in Internal, HasResolver is a public API. However, the module has no doc comment, and HasResolver has no documentation.

If we intend people to provide implementations of HasResolver, we should document the class and its methods, and say what the contract of the implementations is.

If not, we should shift it to Internal.