diff options
-rw-r--r-- | haddock-api/src/Documentation/Haddock.hs | 2 | ||||
-rw-r--r-- | haddock-api/src/Haddock/Backends/LaTeX.hs | 2 | ||||
-rw-r--r-- | haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs | 2 | ||||
-rw-r--r-- | haddock-api/src/Haddock/Backends/Xhtml/Meta.hs | 2 | ||||
-rw-r--r-- | haddock-api/src/Haddock/GhcUtils.hs | 2 | ||||
-rw-r--r-- | haddock-api/src/Haddock/Interface/LexParseRn.hs | 2 | ||||
-rw-r--r-- | haddock-library/src/Documentation/Haddock/Parser.hs | 4 | ||||
-rw-r--r-- | haddock-library/src/Documentation/Haddock/Parser/Monad.hs | 2 | ||||
-rw-r--r-- | html-test/src/Bug308.hs | 2 | ||||
-rw-r--r-- | html-test/src/Bug745.hs | 2 | ||||
-rw-r--r-- | html-test/src/ConstructorArgs.hs | 2 | ||||
-rw-r--r-- | hypsrc-test/src/LinkingIdentifiers.hs | 2 |
12 files changed, 13 insertions, 13 deletions
diff --git a/haddock-api/src/Documentation/Haddock.hs b/haddock-api/src/Documentation/Haddock.hs index 10d6849a..cf244a5f 100644 --- a/haddock-api/src/Documentation/Haddock.hs +++ b/haddock-api/src/Documentation/Haddock.hs @@ -8,7 +8,7 @@ -- Stability : experimental -- Portability : portable -- --- The Haddock API: A rudimentory, highly experimental API exposing some of +-- The Haddock API: A rudimentary, highly experimental API exposing some of -- the internals of Haddock. Don't expect it to be stable. ----------------------------------------------------------------------------- module Documentation.Haddock ( diff --git a/haddock-api/src/Haddock/Backends/LaTeX.hs b/haddock-api/src/Haddock/Backends/LaTeX.hs index abf882f0..5f46b321 100644 --- a/haddock-api/src/Haddock/Backends/LaTeX.hs +++ b/haddock-api/src/Haddock/Backends/LaTeX.hs @@ -1389,7 +1389,7 @@ bold ltx = text "\\textbf" <> braces ltx -- TODO: @verbatim@ is too much since -- --- * Haddock supports markup _inside_ of codeblocks. Right now, the LaTeX +-- * Haddock supports markup _inside_ of code blocks. Right now, the LaTeX -- representing that markup gets printed verbatim -- * Verbatim environments are not supported everywhere (example: not nested -- inside a @tabulary@ environment) diff --git a/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs b/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs index b8f5ac0f..bf29a7b4 100644 --- a/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs +++ b/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs @@ -114,7 +114,7 @@ parHtmlMarkup qual insertAnchors ppId = Markup { -- | We use this intermediate type to transform the input 'Doc' tree -- in an arbitrary way before rendering, such as grouping some --- elements. This is effectivelly a hack to prevent the 'Doc' type +-- elements. This is effectively a hack to prevent the 'Doc' type -- from changing if it is possible to recover the layout information -- we won't need after the fact. data Hack a id = diff --git a/haddock-api/src/Haddock/Backends/Xhtml/Meta.hs b/haddock-api/src/Haddock/Backends/Xhtml/Meta.hs index 621bdd41..540885ac 100644 --- a/haddock-api/src/Haddock/Backends/Xhtml/Meta.hs +++ b/haddock-api/src/Haddock/Backends/Xhtml/Meta.hs @@ -14,7 +14,7 @@ quickjumpVersion = 1 -- | Writes a json encoded file containing additional -- information about the generated documentation. This --- is useful for external tools (e.g. hackage). +-- is useful for external tools (e.g., Hackage). writeHaddockMeta :: FilePath -> Bool -> IO () writeHaddockMeta odir withQuickjump = do let diff --git a/haddock-api/src/Haddock/GhcUtils.hs b/haddock-api/src/Haddock/GhcUtils.hs index 1d6b8bc3..c6bcfb0e 100644 --- a/haddock-api/src/Haddock/GhcUtils.hs +++ b/haddock-api/src/Haddock/GhcUtils.hs @@ -135,7 +135,7 @@ hsSigTypeI = sig_body . unLoc mkEmptySigType :: LHsType GhcRn -> LHsSigType GhcRn -- Dubious, because the implicit binders are empty even --- though the type might have free varaiables +-- though the type might have free variables mkEmptySigType lty@(L loc ty) = L loc $ case ty of HsForAllTy { hst_tele = HsForAllInvis { hsf_invis_bndrs = bndrs } , hst_body = body } diff --git a/haddock-api/src/Haddock/Interface/LexParseRn.hs b/haddock-api/src/Haddock/Interface/LexParseRn.hs index a827cf66..14e1d92b 100644 --- a/haddock-api/src/Haddock/Interface/LexParseRn.hs +++ b/haddock-api/src/Haddock/Interface/LexParseRn.hs @@ -167,7 +167,7 @@ rename dflags gre = rn -- 'GlobalReaderEnv' during 'rename') in an appropriate doc. Currently -- we simply monospace the identifier in most cases except when the -- identifier is qualified: if the identifier is qualified then we can --- still try to guess and generate anchors accross modules but the +-- still try to guess and generate anchors across modules but the -- users shouldn't rely on this doing the right thing. See tickets -- #253 and #375 on the confusion this causes depending on which -- default we pick in 'rename'. diff --git a/haddock-library/src/Documentation/Haddock/Parser.hs b/haddock-library/src/Documentation/Haddock/Parser.hs index de336d45..0943c4e7 100644 --- a/haddock-library/src/Documentation/Haddock/Parser.hs +++ b/haddock-library/src/Documentation/Haddock/Parser.hs @@ -177,7 +177,7 @@ specialChar = "_/<@\"&'`# " -- | Plain, regular parser for text. Called as one of the last parsers -- to ensure that we have already given a chance to more meaningful parsers --- before capturing their characers. +-- before capturing their characters. string' :: Parser (DocH mod a) string' = DocString . unescape . T.unpack <$> takeWhile1_ (`notElem` specialChar) where @@ -710,7 +710,7 @@ stripSpace = fromMaybe <*> mapM strip' Just (' ',t') -> Just t' _ -> Nothing --- | Parses examples. Examples are a paragraph level entitity (separated by an empty line). +-- | Parses examples. Examples are a paragraph level entity (separated by an empty line). -- Consecutive examples are accepted. examples :: Parser (DocH mod a) examples = DocExamples <$> (many (try (skipHorizontalSpace *> "\n")) *> go) diff --git a/haddock-library/src/Documentation/Haddock/Parser/Monad.hs b/haddock-library/src/Documentation/Haddock/Parser/Monad.hs index 7c73a168..109e104e 100644 --- a/haddock-library/src/Documentation/Haddock/Parser/Monad.hs +++ b/haddock-library/src/Documentation/Haddock/Parser/Monad.hs @@ -40,7 +40,7 @@ import Documentation.Haddock.Types ( Version ) import Prelude hiding (takeWhile) import CompatPrelude --- | The only bit of information we really care about truding along with us +-- | The only bit of information we really care about trudging along with us -- through parsing is the version attached to a @\@since@ annotation - if -- the doc even contained one. newtype ParserState = ParserState { diff --git a/html-test/src/Bug308.hs b/html-test/src/Bug308.hs index 93ecffac..250a0622 100644 --- a/html-test/src/Bug308.hs +++ b/html-test/src/Bug308.hs @@ -1,6 +1,6 @@ {-# LANGUAGE Haskell2010 #-} -- From 2.14.x onwards we were forgetting to swallow ‘#’ as a special --- character resulting in broken anchors if they accured +-- character resulting in broken anchors if they occurred -- mid-paragraph. Here we check that anchors get generated as -- expected. module Bug308 where diff --git a/html-test/src/Bug745.hs b/html-test/src/Bug745.hs index 295ac59d..01602bb3 100644 --- a/html-test/src/Bug745.hs +++ b/html-test/src/Bug745.hs @@ -4,6 +4,6 @@ module Bug574 where -- See https://github.com/haskell/haddock/issues/574 --- | Somthing with a spliced type +-- | Something with a spliced type foo :: Int -> $(let i = [t| Int |] in [t| $i -> $i |]) foo x y = x + y diff --git a/html-test/src/ConstructorArgs.hs b/html-test/src/ConstructorArgs.hs index c3b848c3..40697d13 100644 --- a/html-test/src/ConstructorArgs.hs +++ b/html-test/src/ConstructorArgs.hs @@ -50,7 +50,7 @@ pattern Bo :: Int -- ^ an 'Int' -> Boo -- ^ a 'Boo' pattern pattern Bo x y = Foo x y --- | Not bunded and no argument docs +-- | Not bundled and no argument docs pattern Bo' :: Int -> String -> Boo pattern Bo' x y = Foo x y diff --git a/hypsrc-test/src/LinkingIdentifiers.hs b/hypsrc-test/src/LinkingIdentifiers.hs index b195c2c6..068ac542 100644 --- a/hypsrc-test/src/LinkingIdentifiers.hs +++ b/hypsrc-test/src/LinkingIdentifiers.hs @@ -1,5 +1,5 @@ {-# LANGUAGE Haskell2010 #-} --- Tests that the identifers/operators are properly linked even when: +-- Tests that the identifiers/operators are properly linked even when: -- -- * backquoted, parenthesized, vanilla -- * qualified, not-qualified |