[commit: ghc] master: Remove outdated documentation bits concerning -Wmissing-methods (47e2a28)
git at git.haskell.org
git at git.haskell.org
Thu Mar 8 22:06:13 UTC 2018
Repository : ssh://git@git.haskell.org/ghc
On branch : master
Link : http://ghc.haskell.org/trac/ghc/changeset/47e2a28d8c8c80aa9309ceb195ee8671b5a76d3e/ghc
>---------------------------------------------------------------
commit 47e2a28d8c8c80aa9309ceb195ee8671b5a76d3e
Author: Ryan Scott <ryan.gl.scott at gmail.com>
Date: Thu Mar 8 13:23:27 2018 -0500
Remove outdated documentation bits concerning -Wmissing-methods
In commit 503219e3e1667ac39607021b2d9586260fbab32b, we
stopped suppressing `-Wmissing-methods` warnings on class methods
whose names begin with an underscore. However, it seems the users'
guide documentation concerning this was never updated. Let's do so.
Test Plan: Read it
Reviewers: bgamari
Reviewed By: bgamari
Subscribers: rwbarton, thomie, carter
GHC Trac Issues: #12959
Differential Revision: https://phabricator.haskell.org/D4476
>---------------------------------------------------------------
47e2a28d8c8c80aa9309ceb195ee8671b5a76d3e
docs/users_guide/glasgow_exts.rst | 5 ++---
docs/users_guide/using-warnings.rst | 12 ------------
2 files changed, 2 insertions(+), 15 deletions(-)
diff --git a/docs/users_guide/glasgow_exts.rst b/docs/users_guide/glasgow_exts.rst
index 5bcd67e..c6cff92 100644
--- a/docs/users_guide/glasgow_exts.rst
+++ b/docs/users_guide/glasgow_exts.rst
@@ -13778,9 +13778,8 @@ Conjunction binds stronger than disjunction.
If no ``MINIMAL`` pragma is given in the class declaration, it is just as if
a pragma ``{-# MINIMAL op1, op2, ..., opn #-}`` was given, where the
-``opi`` are the methods (a) that lack a default method in the class
-declaration, and (b) whose name that does not start with an underscore
-(c.f. :ghc-flag:`-Wmissing-methods`, :ref:`options-sanity`).
+``opi`` are the methods that lack a default method in the class
+declaration (c.f. :ghc-flag:`-Wmissing-methods`, :ref:`options-sanity`).
This warning can be turned off with the flag
:ghc-flag:`-Wno-missing-methods <-Wmissing-methods>`.
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index 8106003..aeb402d 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -925,18 +925,6 @@ of ``-W(no-)*``.
declaration is missing one or more methods, and the corresponding
class declaration has no default declaration for them.
- The warning is suppressed if the method name begins with an
- underscore. Here's an example where this is useful: ::
-
- class C a where
- _simpleFn :: a -> String
- complexFn :: a -> a -> String
- complexFn x y = ... _simpleFn ...
-
- The idea is that: (a) users of the class will only call
- ``complexFn``; never ``_simpleFn``; and (b) instance declarations
- can define either ``complexFn`` or ``_simpleFn``.
-
The ``MINIMAL`` pragma can be used to change which combination of
methods will be required for instances of a particular class. See
:ref:`minimal-pragma`.
More information about the ghc-commits
mailing list