Skip to content

Haddock fixes #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 24, 2016
Merged

Haddock fixes #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c2e1cb
Added 'since' information to generated command descriptions
qrilka Mar 23, 2016
ae8cef4
Removed occasional dots in command descriptions
qrilka Mar 23, 2016
11ae21f
Regenerated haddocks according to use changes from the previous commits
qrilka Mar 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion codegen/GenCmds.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ data Cmd = Cmd { cmdName, cmdGroup :: String
, cmdRetType :: Maybe String
, cmdArgs :: [Arg]
, cmdSummary :: String
, cmdSince :: String
}
deriving (Show)

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

dropTrailingDot s = case reverse s of
('.':rest) -> reverse rest
_ -> s

haddock = mconcat
[ fromString "-- |", fromString cmdSummary
[ fromString "-- |", fromString (dropTrailingDot cmdSummary)
, fromString " ("
, cmdDescriptionLink cmdName
, fromString ")."
Expand All @@ -267,6 +273,7 @@ exportCmdNames Cmd{..} = types `mappend` functions
, fromString "'."
]
else mempty
, fromString " Since Redis ", fromString cmdSince
]

cmdDescriptionLink :: String -> Builder
Expand Down
Loading