RE: New source documentation policy for GHC

2014-07-15 Thread Simon Peyton Jones
Dear Johan Great. Could you update the Coding style page? https://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle Simon From: ghc-devs [mailto:ghc-devs-boun...@haskell.org] On Behalf Of Johan Tibell Sent: 07 July 2014 08:39 To: ghc-devs@haskell.org Subject: ANN: New source documentation

Re: New source documentation policy for GHC

2014-07-15 Thread Johan Tibell
[mailto:ghc-devs-boun...@haskell.org] *On Behalf Of *Johan Tibell *Sent:* 07 July 2014 08:39 *To:* ghc-devs@haskell.org *Subject:* ANN: New source documentation policy for GHC Hi all! After some discussion [1] we've decided to require Haddock comments for all top-level entities (i.e

ANN: New source documentation policy for GHC

2014-07-07 Thread Johan Tibell
Hi all! After some discussion [1] we've decided to require Haddock comments for all top-level entities (i.e. functions, classes, and data types) in new [2] GHC code. If you're writing new code, please try to add at least a sentence of two documenting what the function does and why. When you're