[GHC] #12050: Allow haddock comments on non-record types

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature | Status: new request | Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | 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 are a variety of cases I have found myself wanting to place haddock documentation on fields of non-record data types rather often in the past. The syntax for this might look like, {{{#!hs data Foo = Foo -- ^ A foo Int -- ^ how big is the foo? String -- ^ the name of the foo }}} -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Description changed by bgamari: @@ -1,4 +1,3 @@ - There are a variety of cases - I have found myself wanting to place haddock documentation on fields of - non-record data types rather often in the past. The syntax for this might - look like, + There are a variety of cases where I have found myself wanting to place + haddock documentation on fields of non-record data types rather often in + the past. The syntax for this might look like, New description: There are a variety of cases where I have found myself wanting to place haddock documentation on fields of non-record data types rather often in the past. The syntax for this might look like, {{{#!hs data Foo = Foo -- ^ A foo Int -- ^ how big is the foo? String -- ^ the name of the foo }}} -- -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #8822 | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by thomie): * related: => #8822 Comment: Also mentioned in ticket:8822#comment:1. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #8822 | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by shlevy): Watching this (is there a better way to subscribe) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #8822 | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Changes (by mpickering): * cc: shlevy (added) -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: feature request | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #8822 | Differential Rev(s): Wiki Page: | https://phabricator.haskell.org/D4094 -------------------------------------+------------------------------------- Changes (by harpocrates): * differential: => https://phabricator.haskell.org/D4094 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#12050: Allow haddock comments on non-record types -------------------------------------+------------------------------------- Reporter: bgamari | Owner: (none) Type: feature request | Status: closed Priority: normal | Milestone: Component: Compiler | Version: 7.10.3 (Parser) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: #8822 | Differential Rev(s): Wiki Page: | https://phabricator.haskell.org/D4094 -------------------------------------+------------------------------------- Changes (by harpocrates): * status: new => closed * resolution: => fixed Comment: Fixed in GHC 8.6. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12050#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC