[commit: ghc] master: users-guide: Improve legibility of OverlappingInstances documentation (fb08252)

git at git.haskell.org git at git.haskell.org
Sun Jul 23 16:55:05 UTC 2017


Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/fb08252ae44dd39e5dcd0de8bd63843eb495f213/ghc

>---------------------------------------------------------------

commit fb08252ae44dd39e5dcd0de8bd63843eb495f213
Author: Ben Gamari <bgamari.foss at gmail.com>
Date:   Sun Jul 23 10:44:09 2017 -0400

    users-guide: Improve legibility of OverlappingInstances documentation
    
    Reviewers: austin
    
    Subscribers: rwbarton, thomie
    
    Differential Revision: https://phabricator.haskell.org/D3776


>---------------------------------------------------------------

fb08252ae44dd39e5dcd0de8bd63843eb495f213
 docs/users_guide/glasgow_exts.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/users_guide/glasgow_exts.rst b/docs/users_guide/glasgow_exts.rst
index 418e7cb..7953067 100644
--- a/docs/users_guide/glasgow_exts.rst
+++ b/docs/users_guide/glasgow_exts.rst
@@ -6044,16 +6044,16 @@ Now suppose that, in some client module, we are searching for an
 instance of the *target constraint* ``(C ty1 .. tyn)``. The search works
 like this:
 
--  Find all instances I that *match* the target constraint; that is, the
-   target constraint is a substitution instance of I. These instance
+-  Find all instances :math:`I` that *match* the target constraint; that is, the
+   target constraint is a substitution instance of :math:`I`. These instance
    declarations are the *candidates*.
 
--  Eliminate any candidate IX for which both of the following hold:
+-  Eliminate any candidate :math:`IX` for which both of the following hold:
 
-   -  There is another candidate IY that is strictly more specific; that
-      is, IY is a substitution instance of IX but not vice versa.
+   -  There is another candidate :math:`IY` that is strictly more specific; that
+      is, :math:`IY` is a substitution instance of :math:`IX` but not vice versa.
 
-   -  Either IX is *overlappable*, or IY is *overlapping*. (This
+   -  Either :math:`IX` is *overlappable*, or :math:`IY` is *overlapping*. (This
       "either/or" design, rather than a "both/and" design, allow a
       client to deliberately override an instance from a library,
       without requiring a change to the library.)



More information about the ghc-commits mailing list