100% Haddock coverage and module reorganization

tweag / webauthn

A library for parsing and validating webauthn/fido2 credentials

Apache License 2.0

34 stars 11 forks source link

100% Haddock coverage and module reorganization #85

Closed ErinvanderVeen closed 2 years ago

ErinvanderVeen commented 2 years ago

This PR attempts to document all modules, which I personally think is complete once we have 100% haddock coverage. I think this is also a good time to mark all Internal modules as such.

infinisil commented 2 years ago

There doesn't appear to be a builtin way for CI to fail when there are warnings unfortunately: https://github.com/haskell/haddock/issues/1393

infinisil commented 2 years ago

A follow-up to this will be #91

infinisil commented 2 years ago

Merging already because this would cause merge conflicts with pretty much anything else we're gonna do

NorfairKing commented 1 year ago

@infinisil Did you ever find a way to ensure 100% haddock coverage?

ErinvanderVeen commented 1 year ago

I don't believe we did find an easy and robust way unfortunately.