Improve source code documentation #1093

Merged
merged 2 commits into from Nov 2, 2012
View
3 Cabal/Distribution/Simple/Command.hs
@@ -103,7 +103,8 @@ data CommandUI flags = CommandUI {
commandName :: String,
-- | A short, one line description of the command to use in help texts.
commandSynopsis :: String,
- -- | The useage line summary for this command
+ -- | A function that maps a program name to a usage summary for this
+ -- command.
commandUsage :: String -> String,
-- | Additional explanation of the command to use in help texts.
commandDescription :: Maybe (String -> String),