Re: interleaved/detached commenting style

2011-04-30 Thread Neil Mitchell
Hi, I had a chance to refresh Hoogle, so now the links work fine. Thanks to Ranjit for generating the original GHC text database. Thanks, Neil On Sat, Apr 30, 2011 at 4:51 PM, Neil Mitchell wrote: > Hi, > > I uploaded ghc.txt and converted it to Hoogle format. The links don't > work since haske

Re: interleaved/detached commenting style

2011-04-30 Thread Neil Mitchell
Hi, I uploaded ghc.txt and converted it to Hoogle format. The links don't work since haskell.org is running an outdated Hoogle (something I hope to have a chance to fix this weekend). You can search with: http://haskell.org/hoogle/?hoogle=%2Bghc+fixed If the GHC build system always built ghc.txt

Re: interleaved/detached commenting style

2011-04-28 Thread Neil Mitchell
Hi Ben, Have you thought about setting up a Hoogle instance for the GHC code base? I know Ranjit (cc'd) has been using it to help him get to grips with GHC, but I can imagine it's useful for all the newcomer GHC developers. If someone sends me the haddock --hoogle text output I'm happy to host it

Re: interleaved/detached commenting style

2011-04-26 Thread Ben Lippmeier
On 25/04/2011, at 12:54 PM, Adam Megacz wrote: > > "Edward Z. Yang" writes: >> 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). > > Okay, perhaps this isn't the best use of my time. I use Haddock all

Re: interleaved/detached commenting style

2011-04-25 Thread Edward Z. Yang
Excerpts from Adam Megacz's message of Sun Apr 24 22:54:55 -0400 2011: > Okay, perhaps this isn't the best use of my time. I mean, alternative representations for the code can come in handy. As you yourself demonstrate, people don't necessarily naturally go for the source, and hyperlinks are a ver

Re: interleaved/detached commenting style

2011-04-24 Thread Adam Megacz
Simon Peyton-Jones writes: > My goal is to use your travels through GHC to make the journey for the > next person easier. > ... > "How could I write some notes (probably in the code) so that > I'd have understood it a lot quicker?" Excerpts from Adam Megacz's message of Sun Apr 24 18:14:16 -040

Re: interleaved/detached commenting style

2011-04-24 Thread 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 > inlin

interleaved/detached commenting style

2011-04-24 Thread Adam Megacz
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 me