[GHC] #11567: Haddock renders wired-in types with kind signature
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: new Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: Documentation Unknown/Multiple | bug Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- Lifted wired-in types seem to be rendered with an unnecessary `TYPE 'Lifted` kind signature. See, for instance, [https://downloads.haskell.org/~ghc/8.0.1-rc2/docs/html/libraries/base-4.9.0.0/Prelude.html#t:Bool|`Bool`]. I'm not yet sure whether this is a ghc or haddock issue. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: new Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Resolution: | Keywords: 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): * cc: goldfire (added) Comment: The [https://downloads.haskell.org/~ghc/8.0.1-rc2/docs/html/libraries/base-4.9.0.... /Data-Proxy.html|instance list] of `Proxy` has similar issues. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: new Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Resolution: | Keywords: 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 RyanGlScott): * Attachment "fixed-data-proxy.png" added. What the docs for Data.Proxy looks like now -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: new Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by RyanGlScott): This was fixed by a [https://github.com/haskell/haddock/pull/476 recent Haddock commit], but GHC 8.0.1-rc2 did not use a sufficiently new version of Haddock. I've attached an image of what `Data.Proxy`'s docs should look like, for reference. (The abnormally long lines for `type Rep` and `type Rep1` should be fixed once [https://github.com/haskell/haddock/pull/482 this] is merged.) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: new Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): The issue I inteded to point out here isn't the use of `TYPE 'Lifted` (which is indeed fixed by your patch) but the fact that kind signatures are rendered at all. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#11567: Haddock renders wired-in types with kind signature -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: bug | Status: closed Priority: high | Milestone: 8.0.1 Component: Documentation | Version: 7.10.3 Resolution: invalid | Keywords: 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): * status: new => closed * resolution: => invalid Comment: Ryan pointed out that these signatures are shown because the modules which export these types have `KindSignatures` enabled. Given that this behavior was exhibited by earlier releases as well, this doesn't seem like a bug. Now that `*` is now rendered as `*` thanks to Ryan's Haddock fix, I'm going to close this. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11567#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC