summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichiel de Bruijne <m.debruijne@matrict.nl>2021-01-05 09:44:11 -0500
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-02-22 18:26:52 -0500
commite1f133bf5ee30f25a94b4f3bf4d26d1a9381f0d9 (patch)
tree6ff9aa4b04431c57ce6c207a2017cd1e051615f6 /docs
parentf90487cacb16e8398c4c4a84de5a1e33ac4e7867 (diff)
downloadhaskell-e1f133bf5ee30f25a94b4f3bf4d26d1a9381f0d9.tar.gz
Prefer -Wmissing-signatures over -Wmissing-exported-signatures (#14794)
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/using-warnings.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index 252b6a5383..5c2c9b66e1 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -1104,7 +1104,7 @@ of ``-W(no-)*``.
.. ghc-flag:: -Wmissing-exported-signatures
:shortdesc: warn about top-level functions without signatures, only if they
- are exported. takes precedence over -Wmissing-signatures
+ are exported
:type: dynamic
:reverse: -Wno-missing-exported-signatures
:category:
@@ -1115,8 +1115,9 @@ of ``-W(no-)*``.
If you would like GHC to check that every exported top-level
function/value has a type signature, but not check unexported
values, use the :ghc-flag:`-Wmissing-exported-signatures`
- option. This option takes precedence over
- :ghc-flag:`-Wmissing-signatures`. As part of the warning GHC also
+ option. If this option is used in conjunction with
+ :ghc-flag:`-Wmissing-signatures` then every top-level function/value
+ must have a type signature. As part of the warning GHC also
reports the inferred type. The option is off by default.
.. ghc-flag:: -Wmissing-local-sigs