Skip to content

Commit 26cebf4

Browse files
Fix some Haddock quoting issues
1 parent de4216f commit 26cebf4

3 files changed

Lines changed: 9 additions & 6 deletions

File tree

System/Console/Docopt/ParseUtils.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ manyTill1 p end = do
7676
rest <- manyTill p end
7777
return $ first : rest
7878

79-
-- |@skipUntil p@ ignores everything that comes before `p`.
80-
-- Returns what `p` returns.
79+
-- |@skipUntil p@ ignores everything that comes before @p@.
80+
-- Returns what @p@ returns.
8181
skipUntil :: Show a => CharParser u a -> CharParser u ()
8282
skipUntil p = skipMany (notFollowedBy p >> anyChar)
8383

System/Console/Docopt/Public.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ notPresent = (not .) . isPresent
107107
-- > Usage:
108108
-- > prog <required>
109109
--
110-
-- then @getArg args (argument \'required\')@ is guaranteed to be a 'Just'.
110+
-- then @getArg args (argument "required")@ is guaranteed to be a 'Just'.
111111
getArg :: Arguments -> Option -> Maybe String
112112
getArg args opt =
113113
case opt `M.lookup` args of

System/Console/Docopt/UsageParse.hs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ pUsagePatterns = do
158158
-- * Option Synonyms & Defaults Parsers
159159

160160
-- | Succeeds only on the first line of an option explanation
161-
-- (one whose first non-space character is '-')
161+
-- (one whose first non-space character is @\'-\'@)
162162
begOptionLine :: CharParser OptInfoMap String
163163
begOptionLine = inlineSpaces >> lookAhead (char '-') >> return "-"
164164

@@ -256,8 +256,11 @@ canRepeat pat target =
256256
-- | Compare on specificity of parsers built from optA and optB,
257257
-- so we can be sure the parser tries the most-specific first, where possible.
258258
-- E.g.
259-
-- LongOption "option" > ShortOption 'o' == True
260-
-- Command "cmd" > Argument "arg" == True
259+
--
260+
-- @
261+
-- LongOption "option" > ShortOption \'o\' == True
262+
-- Command "cmd" > Argument "arg" == True
263+
-- @
261264
compareOptSpecificity :: Option -> Option -> Ordering
262265
compareOptSpecificity optA optB = case optA of
263266
LongOption a -> case optB of

0 commit comments

Comments
 (0)