Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove OPTIONS_HADDOCK prune to have at least some haddock documentation generated #46

Open
jhrcek opened this issue Sep 30, 2024 · 0 comments

Comments

@jhrcek
Copy link

jhrcek commented Sep 30, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant