[commit: haddock] ghc-head, ghc-head1, headdock-library-1.4.5, ie_avails, master, v2.18, wip/revert-ttg-2017-11-20, wip/ttg-2017-10-13, wip/ttg-2017-10-31, wip/ttg-2017-11-06, wip/ttg2-2017-11-10, wip/ttg3-2017-11-12, wip/ttg4-constraints-2017-11-13: Beef up haddock description (#658) (4f3fe0d)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/haddock

On branches: ghc-head,ghc-head1,headdock-library-1.4.5,ie_avails,master,v2.18,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13
Link       : http://git.haskell.org/haddock.git/commitdiff/4f3fe0df65caea76ed268f1907918c19c7da4335

>---------------------------------------------------------------

commit 4f3fe0df65caea76ed268f1907918c19c7da4335
Author: Alexander Biehl <alexbiehl at gmail.com>
Date:   Thu Jul 20 11:25:54 2017 +0200

    Beef up haddock description (#658)
    
    * Beef up haddock description
    
    * Handle empty lines


>---------------------------------------------------------------

4f3fe0df65caea76ed268f1907918c19c7da4335
 haddock.cabal | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/haddock.cabal b/haddock.cabal
index be2efb2..85790ca 100644
--- a/haddock.cabal
+++ b/haddock.cabal
@@ -1,8 +1,26 @@
 name:                 haddock
 version:              2.18.1
 synopsis:             A documentation-generation tool for Haskell libraries
-description:          Haddock is a documentation-generation tool for Haskell
-                      libraries
+description:
+  This is Haddock, a tool for automatically generating documentation
+  from annotated Haskell source code. It is primary intended for documenting
+  library interfaces, but it should be useful for any kind of Haskell code.
+  .
+  Haddock lets you write documentation annotations next to the definitions of
+  functions and types in the source code, in a syntax that is easy on the eye
+  when writing the source code (no heavyweight mark-up).
+  .
+  Haddock understands Haskell's module system, so you can structure your code
+  however you like without worrying that internal structure will be exposed in
+  the generated documentation. For example, it is common to implement a library
+  in several modules, but define the external API by having a single module
+  which re-exports parts of these implementation modules. Using Haddock, you can
+  still write documentation annotations next to the actual definitions of the
+  functions and types in the library, but the documentation annotations from the
+  implementation will be propagated to the external API when the documentation is
+  generated. Abstract types and classes are handled correctly. In fact, even
+  without any documentation annotations, Haddock can generate useful documentation
+  from your source code.
 license:              BSD3
 license-file:         LICENSE
 author:               Simon Marlow, David Waern