hiding documentation for non-exposed modules
I'm using cabal to build and install a new library I'm writing. In the .cabal file I've exposed only a single module. However, the haddock generated documentation includes even the non-exposed modules, which is not what I want since end-users should not see these. Is there a way to tell cabal to build documentation only for exposed modules?
The pragma
{-# OPTIONS_HADDOCK hide #-}
does what I want, but it seems to me that cabal should be handling this.
On Tue, Mar 30, 2010 at 2:55 PM, Ashish Agarwal
I'm using cabal to build and install a new library I'm writing. In the .cabal file I've exposed only a single module. However, the haddock generated documentation includes even the non-exposed modules, which is not what I want since end-users should not see these. Is there a way to tell cabal to build documentation only for exposed modules?
On Mar 30, 2010, at 2:55 PM, Ashish Agarwal wrote:
However, the haddock generated documentation includes even the non-exposed modules, which is not what I want since end-users should not see these.
And why do you feel that way? Some of us are old enough to remember the "glass walls, men in white coats" era of computing. Shouldn't Haskell be a language where everyone gets to see everything? Put this differently, coming from any language with an order of magnitude more users and a careful vetting process for libraries, it can sure seem at first like Hackage is a hippy co-op where any anyone can put food up on the shelves. (Actually, that is the case!) Going out of your way to make it easy to see your beautiful code can help set people at ease, assuring them that they don't have to rely just on "standard packages" and their own code.
participants (2)
-
Ashish Agarwal -
Dave Bayer