search

haskell / haddock

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

show COMPLETE pragmas in documentation #1625

Closed olafklinke closed 1 month ago

olafklinke commented 5 months ago

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.

Kleidukos commented 1 month ago

Hi, thank you for this ticket,but Haddock now lives full-time in the GHC repository! Read more at https://discourse.haskell.org/t/haddock-now-lives-in-the-ghc-repository/9576.

Let me know if you feel it is still needed, and I'll migrate it. :)