[GHC] #15296: Sentence is about Complex type but mentions Simple constructor

GHC ghc-devs at haskell.org
Thu Jun 21 08:49:43 UTC 2018


#15296: Sentence is about Complex type but mentions Simple constructor
-------------------------------------+-------------------------------------
           Reporter:  v0d1ch         |             Owner:  (none)
               Type:  bug            |            Status:  new
           Priority:  normal         |         Milestone:  8.6.1
          Component:  Documentation  |           Version:  8.4.3
           Keywords:                 |  Operating System:  Unknown/Multiple
       Architecture:                 |   Type of failure:  None/Unknown
  Unknown/Multiple                   |
          Test Case:                 |        Blocked By:
           Blocking:                 |   Related Tickets:
Differential Rev(s):                 |         Wiki Page:
-------------------------------------+-------------------------------------
 There is a mistype in one of the sentences regarding Roles in the
 documentation :
 https://ghc.readthedocs.io/en/latest/glasgow_exts.html#nominal-
 representational-and-phantom

 {{{
 Here are some examples:

 data Simple a = MkSimple a          -- a has role representational

 type family F
 type instance F Int = Bool
 type instance F Age = Char

 data Complex a = MkComplex (F a)    -- a has role nominal

 data Phant a = MkPhant Bool         -- a has role phantom
 }}}
 The type Simple has its parameter at role representational, which is
 generally the most common case. Simple Age would have the same
 representation as Simple Int. The type Complex, on the other hand, has its
 parameter at role nominal, because Simple Age and Simple Int are not the
 same. Lastly, Phant Age and Phant Bool have the same representation, even
 though Age and Bool are unrelated.


 The wrong sentence is `The type Complex, on the other hand, has its
 parameter at role nominal, because Simple Age and Simple Int are not the
 same. `

-- 
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15296>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list