search

haskell / haddock

Haskell Documentation Tool
www.haskell.org/haddock/
BSD 2-Clause "Simplified" License
361 stars 241 forks source link

A way to fail on missing docs #1393

Open NorfairKing opened 3 years ago

NorfairKing commented 3 years ago

I'd like to ensure that my library is fully documented by failing the build if haddock fails. So I think I'd like something like -Werror for haddock, because I see that haddock can already warn against missing docs.

infinisil commented 2 years ago

I just thought of a slighty hacky way to achieve this: Since there's the --no-warnings flag, it's possible to do one run without the flag and one with, if the output changes based on the flag, there's warnings.

NorfairKing commented 1 year ago

cc @tchoutri