Clean up module intro documentation.
authorDavid Terei <code@davidterei.com>
Thu, 19 Mar 2015 09:03:01 +0000 (02:03 -0700)
committerDavid Terei <code@davidterei.com>
Thu, 19 Mar 2015 09:03:01 +0000 (02:03 -0700)
src/Text/PrettyPrint.hs
src/Text/PrettyPrint/Annotated.hs
src/Text/PrettyPrint/Annotated/HughesPJ.hs
src/Text/PrettyPrint/Annotated/HughesPJClass.hs

index 0d6b6d4..6c65111 100644 (file)
@@ -15,7 +15,7 @@
 -- that provides a way to easily print out text in a consistent format
 -- of your choosing.
 --
--- This module should be used as opposed to the "Text.PrettyPrint.HughesPJ"
+-- This module should be used as opposed to the 'Text.PrettyPrint.HughesPJ'
 -- module. Both are equivalent though as this module simply re-exports the
 -- other.
 --
index dc967e6..a9e5862 100644 (file)
@@ -4,20 +4,20 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Text.PrettyPrint.Annotated
--- Copyright   :  (c) The University of Glasgow 2001
+-- Copyright   :  (c) Trevor Elliott <revor@galois.com> 2015
 -- License     :  BSD-style (see the file LICENSE)
 -- 
 -- Maintainer  :  David Terei <code@davidterei.com>
 -- Stability   :  stable
 -- Portability :  portable
 --
--- Provides a collection of pretty printer combinators, a set of API's
--- that provides a way to easily print out text in a consistent format
--- of your choosing.
+-- This module provides a version of pretty that allows for annotations to be
+-- attached to documents. Annotations are arbitrary pieces of metadata that can
+-- be attached to sub-documents.
 --
--- This module should be used as opposed to the "Text.PrettyPrint.HughesPJ"
--- module. Both are equivalent though as this module simply re-exports the
--- other.
+-- This module should be used as opposed to the
+-- 'Text.PrettyPrint.Annotated.HughesPJ' module. Both are equivalent though as
+-- this module simply re-exports the other.
 --
 -----------------------------------------------------------------------------
 
index dfc48dd..02fe34c 100644 (file)
@@ -8,24 +8,16 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Text.PrettyPrint.Annotated.HughesPJ
--- Copyright   :  (c) The University of Glasgow 2001
+-- Copyright   :  (c) Trevor Elliott <revor@galois.com> 2015
 -- License     :  BSD-style (see the file LICENSE)
 --
 -- Maintainer  :  David Terei <code@davidterei.com>
 -- Stability   :  stable
 -- Portability :  portable
 --
--- Provides a collection of pretty printer combinators, a set of API's
--- that provides a way to easily print out text in a consistent format
--- of your choosing.
---
--- Originally designed by John Hughes's and Simon Peyton Jones's.
---
--- For more information you can refer to the
--- <http://belle.sourceforge.net/doc/hughes95design.pdf original paper> that
--- serves as the basis for this libraries design:
--- /The Design -- of a Pretty-printing Library/ by John Hughes, in Advanced
--- Functional Programming, 1995
+-- This module provides a version of pretty that allows for annotations to be
+-- attached to documents. Annotations are arbitrary pieces of metadata that can
+-- be attached to sub-documents.
 --
 -----------------------------------------------------------------------------
 
index 4e2b2c7..1aefc49 100644 (file)
@@ -5,17 +5,18 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Text.PrettyPrint.Annotated.HughesPJClass
--- Copyright   :  (c) Lennart Augustsson 2014
+-- Copyright   :  (c) Trevor Elliott <revor@galois.com> 2015
 -- License     :  BSD-style (see the file LICENSE)
 --
 -- Maintainer  :  David Terei <code@davidterei.com>
 -- Stability   :  stable
 -- Portability :  portable
 --
--- Pretty printing class, simlar to 'Show' but nicer looking. 
+-- Pretty printing class, simlar to 'Show' but nicer looking.
 --
 -- Note that the precedence level is a 'Rational' so there is an unlimited
--- number of levels. This module re-exports 'Text.PrettyPrint.HughesPJ'.
+-- number of levels. This module re-exports
+-- 'Text.PrettyPrint.Annotated.HughesPJ'.
 --
 -----------------------------------------------------------------------------