You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello,
I just wanted to incorporate this library (as part of using oidc-client which depends on it) in our application.
I was a bit confused about why there's no Haddock generated for many modules (e.g. see https://hackage.haskell.org/package/jose-jwt-0.10.0/docs/Jose-Jwk.html which is empty, even though the module exposes quite a few things.)
It seems that {-# OPTIONS_HADDOCK prune #-} is used in bunch of places, which based on haddock documentation means "Omit definitions that have no documentation annotations from the generated documentation."
I think it would be useful to have at least some documentation available (as opposed to letting users figure out the api by reading the source code). Would you be open to removing the haddock prune option and re-generating / reuploading the docs to hackage?
Hello,
I just wanted to incorporate this library (as part of using oidc-client which depends on it) in our application.
I was a bit confused about why there's no Haddock generated for many modules (e.g. see https://hackage.haskell.org/package/jose-jwt-0.10.0/docs/Jose-Jwk.html which is empty, even though the module exposes quite a few things.)
It seems that
{-# OPTIONS_HADDOCK prune #-}
is used in bunch of places, which based on haddock documentation means "Omit definitions that have no documentation annotations from the generated documentation."I think it would be useful to have at least some documentation available (as opposed to letting users figure out the api by reading the source code). Would you be open to removing the haddock prune option and re-generating / reuploading the docs to hackage?
EDIT: anticipating a question: why would you want to read haddocks of Jose.Jwk?
Because the type Jwk is part of oidc-client Provider configuration (https://hackage.haskell.org/package/oidc-client-0.8.0.0/docs/Web-OIDC-Client-Discovery.html#t:Provider) and I like browsing the haddocks to understand the types.
The text was updated successfully, but these errors were encountered: