Skip to content

Commit 74cc620

Browse files
committed
Merge pull request #62 from qrilka/haddock-fixes
Haddock fixes
2 parents 15da23e + 11ae21f commit 74cc620

File tree

2 files changed

+159
-152
lines changed

2 files changed

+159
-152
lines changed

codegen/GenCmds.hs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ data Cmd = Cmd { cmdName, cmdGroup :: String
101101
, cmdRetType :: Maybe String
102102
, cmdArgs :: [Arg]
103103
, cmdSummary :: String
104+
, cmdSince :: String
104105
}
105106
deriving (Show)
106107

@@ -123,6 +124,7 @@ instance FromJSON Cmds where
123124
cmdGroup <- cmd .: "group"
124125
cmdRetType <- cmd .:? "returns"
125126
cmdSummary <- cmd .: "summary"
127+
cmdSince <- cmd .: "since"
126128
cmdArgs <- cmd .:? "arguments" .!= []
127129
<|> error ("failed to parse args: " ++ cmdName)
128130
return Cmd{..})
@@ -253,8 +255,12 @@ exportCmdNames Cmd{..} = types `mappend` functions
253255
Just (Just (_,ts)) -> ts
254256
Just Nothing -> error "unhandled"
255257

258+
dropTrailingDot s = case reverse s of
259+
('.':rest) -> reverse rest
260+
_ -> s
261+
256262
haddock = mconcat
257-
[ fromString "-- |", fromString cmdSummary
263+
[ fromString "-- |", fromString (dropTrailingDot cmdSummary)
258264
, fromString " ("
259265
, cmdDescriptionLink cmdName
260266
, fromString ")."
@@ -267,6 +273,7 @@ exportCmdNames Cmd{..} = types `mappend` functions
267273
, fromString "'."
268274
]
269275
else mempty
276+
, fromString " Since Redis ", fromString cmdSince
270277
]
271278

272279
cmdDescriptionLink :: String -> Builder

0 commit comments

Comments
 (0)