From 856adf54ab50fc3be66d17a0b94ba3074453b279 Mon Sep 17 00:00:00 2001
From: Ben Gamari <ben@smart-cactus.org>
Date: Wed, 20 May 2020 12:26:05 -0400
Subject: [PATCH] users-guide: Clarify meaning of -haddock flag
Fixes #18206.
---
docs/users_guide/using.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/users_guide/using.rst b/docs/users_guide/using.rst
index 7bdd421facd..5b8425fc9ec 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
--
GitLab