diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2020-05-20 12:26:05 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-05-23 13:40:21 -0400 |
| commit | 856adf54ab50fc3be66d17a0b94ba3074453b279 (patch) | |
| tree | bef3025717514b9fb553a4df95c48baf2cdf7de9 | |
| parent | a60dc83552c38af9bbc159bd4e092531196db9c0 (diff) | |
| download | haskell-856adf54ab50fc3be66d17a0b94ba3074453b279.tar.gz | |
users-guide: Clarify meaning of -haddock flag
Fixes #18206.
| -rw-r--r-- | docs/users_guide/using.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/users_guide/using.rst b/docs/users_guide/using.rst index 7bdd421fac..5b8425fc9e 100644 --- a/docs/users_guide/using.rst +++ b/docs/users_guide/using.rst @@ -1136,10 +1136,11 @@ Haddock single: haddock .. ghc-flag:: -haddock - :shortdesc: Make the parser more strict about Haddock comments. + :shortdesc: With this flag GHC will parse Haddock comments and include them + in the interface file it produces. :type: dynamic :reverse: -no-haddock - :category: misc + :category: haddock By default, GHC ignores Haddock comments (``-- | ...`` and ``-- ^ ...``) and does not check that they're associated with a valid term, such as a |