[haddock] #76: Non-use of __HADDOCK__ flag is not documented

haddock haddock at projects.haskell.org
Sat Jun 27 12:31:51 EDT 2009


#76: Non-use of __HADDOCK__ flag is not documented
-------------------+--------------------------------------------------------
Reporter:  SamB    |        Owner:          
    Type:  defect  |       Status:  reopened
Priority:  major   |    Milestone:  2.5.0   
 Version:          |   Resolution:          
Keywords:          |  
-------------------+--------------------------------------------------------
Changes (by SamB):

  * status:  closed => reopened
  * resolution:  wontfix =>

Comment:

 I think *that* should be documented in the manual. Macros with names of
 the form __FOO__ have a strong tradition of being predefined by relevant
 systems; think of __STDC__, __GNUC__, and __OBJC__ in the C world and
 __GLASGOW_HASKELL__, __HUGS__, and __NHC__ in the Haskell world. Because
 of this tradition, explicitly documenting that Haddock does not define and
 has not ever defined __HADDOCK__ would be a very good thing to do, and if
 there were a good reference about what *has* traditionally defined this
 macro, it would be desirable to direct people to that.

 You can see what confusion not having this in the manual caused me!

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/76#comment:3>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool


More information about the Haddock mailing list