diff options
| author | Ryan Scott <ryan.gl.scott@gmail.com> | 2018-03-08 13:23:27 -0500 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-03-08 16:08:04 -0500 |
| commit | 47e2a28d8c8c80aa9309ceb195ee8671b5a76d3e (patch) | |
| tree | 458c23917780d6010ccfab89f893fe26a77cffa1 /docs/users_guide/using-warnings.rst | |
| parent | 94f02547083cf6df686ea0b95fed050184c533de (diff) | |
| download | haskell-47e2a28d8c8c80aa9309ceb195ee8671b5a76d3e.tar.gz | |
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
Diffstat (limited to 'docs/users_guide/using-warnings.rst')
| -rw-r--r-- | docs/users_guide/using-warnings.rst | 12 |
1 files changed, 0 insertions, 12 deletions
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst index 8106003f7d..aeb402d7ce 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`. |
