>> Hi,
>>
>> Haddock options in source files can look either like this:
>>
>> -- # prune, hide, etc
>>
>> Or like this:
>>
>> {-# prune, hide, etc #-}
>>
>> Since the second one was hard to support in GHC, and because I wanted to
>> implement something that fit better with the GHC system of
>> options/pragmas, I implemented support for Haddock options solely
>> through
>> a new pragma: {-# DOC_OPTIONS #-}.
>>
>> My question is: Do you like this change and should we update packages to
>> support it, or should we also support the "-- #" style options for
>> backwards-compatibility?
>
> Sorry, with "also support the -- # style options" I mean to add support
> for them to GHC's lexer so that Haddock 2.0 supports them as well. They
> should of course never be removed from the source files.

We took this discussion over IRC, and concluded that DOC_OPTIONS should be
renamed to HADDOCK_OPTIONS, and that it would be best to support "-- # .."
-style options with a deprecation message.

Also, the "hide" option could probably be entirely deprecated in favor of
using the exposed/hidden module distinction in Cabal.

David

_______________________________________________
Cvs-ghc mailing list
[email protected]
http://www.haskell.org/mailman/listinfo/cvs-ghc

Reply via email to