[commit: packages/pretty] master: Improve module description for HughesPJ (b093b1e)

git at git.haskell.org git at git.haskell.org
Wed Dec 16 07:11:37 UTC 2015


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

On branch  : master
Link       : http://git.haskell.org/packages/pretty.git/commitdiff/b093b1e2eebd0023e6cdf003fd0723d32ecda968

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

commit b093b1e2eebd0023e6cdf003fd0723d32ecda968
Author: David Terei <code at davidterei.com>
Date:   Fri Dec 26 00:38:36 2014 -0800

    Improve module description for HughesPJ


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

b093b1e2eebd0023e6cdf003fd0723d32ecda968
 src/Text/PrettyPrint/HughesPJ.hs | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/src/Text/PrettyPrint/HughesPJ.hs b/src/Text/PrettyPrint/HughesPJ.hs
index c45f691..a091bdd 100644
--- a/src/Text/PrettyPrint/HughesPJ.hs
+++ b/src/Text/PrettyPrint/HughesPJ.hs
@@ -15,12 +15,17 @@
 -- Stability   :  stable
 -- Portability :  portable
 --
--- John Hughes's and Simon Peyton Jones's Pretty Printer Combinators
+-- 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.
 --
--- Based on /The Design of a Pretty-printing Library/
--- in Advanced Functional Programming,
--- Johan Jeuring and Erik Meijer (eds), LNCS 925
--- <http://www.cs.chalmers.se/~rjmh/Papers/pretty.ps>
+-- 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
 --
 -----------------------------------------------------------------------------
 
@@ -58,7 +63,6 @@ module Text.PrettyPrint.HughesPJ (
 
         -- * Utility functions for documents
         first, reduceDoc,
-        -- TODO: Should these be exported? Previously they weren't
 
         -- * Rendering documents
 



More information about the ghc-commits mailing list