[GHC] #14199: Document Type.Reflection better (Fun and Con')
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Compiler | Version: 8.2.1 Keywords: Typeable | Operating System: Unknown/Multiple Architecture: | Type of failure: Documentation Unknown/Multiple | bug Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- The pattern synonym `Type.Reflection.Fun` is not documented at all. Since it seems a bit subtle (`(->)` being more than just a type constructor), I think it actually deserves ''extra'' documentation, with examples. The pattern synonym `Type.Reflection.Con'` is insufficiently documented. Some examples would probably help. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by dfeuer): * component: Compiler => Core Libraries -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * owner: (none) => bgamari -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: patch Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: new => patch * differential: => Phab:D3943 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: patch Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"f9bf621caf2fc17d829dee0ee48b204144927e72/ghc" f9bf621/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="f9bf621caf2fc17d829dee0ee48b204144927e72" Better document TypeRep patterns As pointed out in #14199 these are rather non-trivial; extra documentation is in order. [skip ci] Test Plan: Read it Reviewers: dfeuer, austin, hvr Subscribers: rwbarton, thomie GHC Trac Issues: #14199 Differential Revision: https://phabricator.haskell.org/D3943 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: merge Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => merge -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: merge Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943 Wiki Page: | -------------------------------------+------------------------------------- Comment (by dfeuer): I think it would be helpful to explain, in the documentation of `Con'` and `App`, just what separates the variables that can be separated with `App` from the ones that can be separated with `Con'`. For example, given {{{#!hs data Foo j k (l :: j -> k) }}} one might naively expect something like `App (App (App (Con Foo) Bool) Type) SBool`, but that is not so. Going into a bit more detail about that would be helpful, and it might even be worth mentioning ''why'' the naive guess is wrong. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: merge Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943 Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Thanks David, that is quite helpful feedback. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:7> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: bgamari Type: bug | Status: merge Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Changes (by bgamari): * differential: Phab:D3943 => Phab:D3943, Phab:D3991 Comment: There's some more documentation improvements in Phab:D3991. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:8> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Changes (by bgamari): * owner: bgamari => (none) * status: merge => new -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:9> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Comment (by bgamari): comment:4 merged to `ghc-8.2` as 14195b0982135668890f79b7790caf33c6147240. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:10> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"6de1a5a96cdaba080570e9f47ff8711796e2e83b/ghc" 6de1a5a9/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="6de1a5a96cdaba080570e9f47ff8711796e2e83b" Document Typeable's treatment of kind polymorphic tycons Test Plan: Read it Reviewers: dfeuer, goldfire, austin, hvr Reviewed By: dfeuer Subscribers: rwbarton, thomie GHC Trac Issues: #14199 Differential Revision: https://phabricator.haskell.org/D3991 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:11> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: merge Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Changes (by bgamari): * status: new => merge -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:12> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#14199: Document Type.Reflection better (Fun and Con') -------------------------------------+------------------------------------- Reporter: dfeuer | Owner: (none) Type: bug | Status: closed Priority: high | Milestone: 8.2.2 Component: Core Libraries | Version: 8.2.1 Resolution: fixed | Keywords: Typeable Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3943, Wiki Page: | Phab:D3991 -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * resolution: => fixed Comment: Merged to `ghc-8.2` in 98f3bdd6af349bc020013335a1a9b17612d23115. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14199#comment:13> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC