Skip to content

Commit 6ed2e05

Browse files
committed
Cosmetic documentation fixes: punctuation, capitalization
1 parent b996631 commit 6ed2e05

File tree

3 files changed

+128
-129
lines changed

3 files changed

+128
-129
lines changed

Language/Haskell/Pretty.hs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ infixl 5 $$$
4343
-----------------------------------------------------------------------------
4444

4545
-- | Varieties of layout we can use.
46-
data PPLayout = PPOffsideRule -- ^ classical layout
47-
| PPSemiColon -- ^ classical layout made explicit
48-
| PPInLine -- ^ inline decls, with newlines between them
49-
| PPNoLayout -- ^ everything on a single line
46+
data PPLayout = PPOffsideRule -- ^ Classical layout.
47+
| PPSemiColon -- ^ Classical layout made explicit.
48+
| PPInLine -- ^ Inline decls, with newlines between them.
49+
| PPNoLayout -- ^ Everything on a single line.
5050
deriving Eq
5151

5252
type Indent = Int
@@ -55,29 +55,29 @@ type Indent = Int
5555
--
5656
-- /Note:/ the 'onsideIndent' must be positive and less than all other indents.
5757
data PPHsMode = PPHsMode {
58-
-- | indentation of a class or instance
58+
-- | Indentation of a class or instance.
5959
classIndent :: Indent,
60-
-- | indentation of a @do@-expression
60+
-- | Indentation of a @do@-expression.
6161
doIndent :: Indent,
62-
-- | indentation of the body of a
63-
-- @case@ expression
62+
-- | Indentation of the body of a
63+
-- @case@ expression.
6464
caseIndent :: Indent,
65-
-- | indentation of the declarations in a
66-
-- @let@ expression
65+
-- | Indentation of the declarations in a
66+
-- @let@ expression.
6767
letIndent :: Indent,
68-
-- | indentation of the declarations in a
69-
-- @where@ clause
68+
-- | Indentation of the declarations in a
69+
-- @where@ clause.
7070
whereIndent :: Indent,
71-
-- | indentation added for continuation
72-
-- lines that would otherwise be offside
71+
-- | Indentation added for continuation
72+
-- lines that would otherwise be offside.
7373
onsideIndent :: Indent,
74-
-- | blank lines between statements?
74+
-- | Blank lines between statements?
7575
spacing :: Bool,
76-
-- | Pretty-printing style to use
76+
-- | Pretty-printing style to use.
7777
layout :: PPLayout,
78-
-- | add GHC-style @LINE@ pragmas to output?
78+
-- | Add GHC-style @LINE@ pragmas to output?
7979
linePragmas :: Bool,
80-
-- | not implemented yet
80+
-- | (not implemented yet)
8181
comments :: Bool
8282
}
8383

0 commit comments

Comments
 (0)