[Git][ghc/ghc][master] users-guide: Clarify meaning of -haddock flag

[Marge Bot]

 Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
856adf54 by Ben Gamari at 2020-05-23T13:40:21-04:00
users-guide: Clarify meaning of -haddock flag

Fixes #18206.

- - - - -


1 changed file:

- docs/users_guide/using.rst


Changes:

=====================================
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



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/856adf54ab50fc3be66d17a0b94ba3074453b279

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/856adf54ab50fc3be66d17a0b94ba3074453b279
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20200523/c8567b94/attachment.html>