[GHC] #15240: GHCi's :doc doesn't find the documentation for some class methods
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: (none) Type: bug | Status: new Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: Other Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- While `:doc` reliably finds the docs for classes like Foldable and Monad, it fails for some methods. {{{ λ :doc return Inject a value into the monadic type. λ :doc foldr <has no documentation> λ :doc show <has no documentation> }}} So far I haven't been able to see a pattern there. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: (none) Type: bug | Status: new Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by sjakobi): `--show-iface` reveals that e.g. `GHC/Show.hi` ''does'' contain docs for `show`: {{{ show: " A specialised variant of 'showsPrec', using precedence context zero, and returning an ordinary 'String'." }}} So either we're loading the wrong iface our `Name` isn't the same as the one in the `DeclDocMap`. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: sjakobi Type: bug | Status: new Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by sjakobi): * owner: (none) => sjakobi -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: sjakobi Type: bug | Status: patch Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4816 Wiki Page: | -------------------------------------+------------------------------------- Changes (by sjakobi): * status: new => patch * differential: => Phab:D4816 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: sjakobi Type: bug | Status: closed Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4816 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => closed * resolution: => fixed -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15240: GHCi's :doc doesn't find the documentation for some class methods -------------------------------------+------------------------------------- Reporter: sjakobi | Owner: sjakobi Type: bug | Status: closed Priority: normal | Milestone: 8.6.1 Component: GHCi | Version: 8.5 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4816 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"69b50efe08bdd09de0b4f0208fe52804ad938853/ghc" 69b50efe/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="69b50efe08bdd09de0b4f0208fe52804ad938853" Fix deserialization of docs (#15240) We were using Map.fromDistinctAscList to deserialize a (Map Name HsDocString). As the Names' Uniques had changed, we ended up with an invalid map in which we couldn't lookup certain keys. Switching to Map.fromList fixed the issue. Added comments in several places. Reviewers: alexbiehl, hvr, bgamari Reviewed By: bgamari Subscribers: rwbarton, thomie, carter GHC Trac Issues: #15240 Differential Revision: https://phabricator.haskell.org/D4816 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15240#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC