haddock
haddock copied to clipboard
show COMPLETE pragmas in documentation
This is a feature request.
Much like MINIMAL
pragmas for type classes, the COMPLETE
pragma is used to signal a contract, namely that a set of functions (patterns in this case) cover a type. While the MINIMAL
pragma is picked up by Haddock, COMPLETE
is not. Thus the only way for a library user to discover this information is either to look at the source or compile with Wincomplete-uni-patterns.
Relevant haskell-cafe-thread: Wincomplete-uni-patterns and bidirectional patterns
A prominent example and test case is the module Data.Sequence.Internal which contains two COMPLETE
pragmas.