interleaved/detached commenting style

[Edward Z. Yang]

The feeling I get is most of GHC HQ doesn't use Haddock to browse
GHC... we go straight for the source (with maybe ctags/hasktags
setup).

Edward

Excerpts from Adam Megacz's message of Sun Apr 24 18:14:16 -0400 2011:
> 
> The (new) commentary describes a mechanism for creating "links" from
> inline/interleaved comments to detached comments:
> 
>   http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Commentsandcommitmessages
> 
> Is Haddock aware of this mechanism on some level?  If not, does it have
> a similar mechanism?
> 
> I bring this up because people learning their way around the code for
> the first time are likely to do so via the Haddock HTML, and these
> multi-screen-long detached comments contain the answers to many newbie
> questions.  At least three of my postings to this list were answered by
> a pointer to a non-Haddock-visible detached comment.
> 
>   - a
>