[GHC] #11768: Need a way to attach Haddock documentation to derived instances

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature | Status: new request | Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.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: -------------------------------------+------------------------------------- In the case of `base` we'd like to be able to attach Haddock `@since` annotations on new typeclass instances. Unfortunately many instances are derived, which we can't currently attach Haddock documentation to. Fix this. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #11767 | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * related: => #11767 @@ -2,3 +2,3 @@ - annotations on new typeclass instances. Unfortunately many instances are - derived, which we can't currently attach Haddock documentation to. Fix - this. + annotations on new typeclass instances (see #11767). Unfortunately many + instances are derived, which we can't currently attach Haddock + documentation to. Fix this. New description: In the case of `base` we'd like to be able to attach Haddock `@since` annotations on new typeclass instances (see #11767). Unfortunately many instances are derived, which we can't currently attach Haddock documentation to. Fix this. -- -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #11767 | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by RyanGlScott): * cc: RyanGlScott (added) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: patch Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #11767 | Differential Rev(s): Phab:D2175 Wiki Page: | -------------------------------------+------------------------------------- Changes (by RyanGlScott): * status: new => patch * differential: => Phab:D2175 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: patch Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #11767 | Differential Rev(s): Phab:D2175 Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): See [[https://github.com/haskell/haddock/pull/499/files|Haddock #499]] for the Haddock piece of this. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11768: Need a way to attach Haddock documentation to derived instances
-------------------------------------+-------------------------------------
Reporter: bgamari | Owner:
Type: feature request | Status: patch
Priority: normal | Milestone: 8.2.1
Component: Compiler | Version: 7.10.3
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture:
| Unknown/Multiple
Type of failure: None/Unknown | Test Case:
Blocked By: | Blocking:
Related Tickets: #11767 | Differential Rev(s): Phab:D2175
Wiki Page: |
-------------------------------------+-------------------------------------
Comment (by Ben Gamari

#11768: Need a way to attach Haddock documentation to derived instances -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: closed Priority: normal | Milestone: 8.2.1 Component: Compiler | Version: 7.10.3 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #11767 | Differential Rev(s): Phab:D2175 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => closed * resolution: => fixed -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11768#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC