haddock-location-signature
Description | Where to put docstring comments in function signatures |
---|---|
Options |
|
Default | auto |
Ormolu | auto |
Since | Unreleased |
When not specified, defaults to:
If
function-arrows=leading
=>trailing
If
function-arrows=leading-args
=>trailing
If
function-arrows=trailing
=>leading
Examples
func
-- | Arg 1
:: Int
-- | Arg 2
-> String
-- | Return value
-> Int
func ::
-- | Arg 1
Int ->
-- | Arg 2
String ->
-- | Return value
Int
func
:: Int
-- ^ Arg 1
-> String
-- ^ Arg 2
-> Int
-- ^ Return value
func ::
Int ->
-- ^ Arg 1
String ->
-- ^ Arg 2
Int
-- ^ Return value
For more examples, see the test files.