[GHC] #10398: Support consecutive named Haddock comments
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: new Priority: normal | Milestone: Component: Compiler | Version: 7.10.1 (Parser) | Operating System: Unknown/Multiple Keywords: | Type of failure: Other Architecture: | Blocked By: Unknown/Multiple | Related Tickets: Test Case: | Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- (I don't sufficiently understand the manner in which this arises from a GHC issue, but reliable sources inform me that it does.) This haddock issue, https://github.com/haskell/haddock/issues/392, apparently is related to the manner in which GHC parses comments. The way it manifests is that {{{#!hs module Foo ( -- $chunk1 -- $chunk2 foo, -- $chunk3 bar ) where {- $chunk1 This is chunk 1. -} {- $chunk2 This is chunk 2. -} {- $chunk3 This is chunk 3. -} foo = 3 bar = 7 }}} The resulting haddock documentation will include chunks 1 and 3 but not 2. See the linked ticket for a discussion by Mateusz Kowalczyk explaining how this relates to GHC. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: patch Priority: normal | Milestone: 7.10.3 Component: Compiler | Version: 7.10.1 (Parser) | Keywords: Resolution: | Architecture: Operating System: Unknown/Multiple | Unknown/Multiple Type of failure: Other | Test Case: Blocked By: | haddock/should_compile_flag_haddock/T10398 Related Tickets: | Blocking: | Differential Revisions: Phab:D1025 -------------------------------------+------------------------------------- Changes (by thomie): * status: new => patch * testcase: => haddock/should_compile_flag_haddock/T10398 * differential: => Phab:D1025 * milestone: => 7.10.3 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: patch Priority: normal | Milestone: 7.10.3 Component: Compiler | Version: 7.10.1 (Parser) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: | haddock/should_compile_flag_haddock/T10398 Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1025 -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"d784bdeb62a6b11831c5235a97449ff2a86dcc52/ghc" d784bde/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="d784bdeb62a6b11831c5235a97449ff2a86dcc52" Lexer: support consecutive references to Haddock chunks (#10398) Reviewers: austin, bgamari, Fuuzetsu Reviewed By: bgamari Subscribers: thomie, bgamari Differential Revision: https://phabricator.haskell.org/D1025 GHC Trac Issues: #10398 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: closed Priority: normal | Milestone: 7.10.3 Component: Compiler | Version: 7.10.1 (Parser) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: | haddock/should_compile_flag_haddock/T10398 Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1025 -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => closed * resolution: => fixed -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: closed Priority: normal | Milestone: 7.12.1 Component: Compiler | Version: 7.10.1 (Parser) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: | haddock/should_compile_flag_haddock/T10398 Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1025 -------------------------------------+------------------------------------- Changes (by hvr): * milestone: 7.10.3 => 7.12.1 Comment: This was never merged to 7.10, so I assume the milestone was wrong -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: closed Priority: normal | Milestone: 7.12.1 Component: Compiler | Version: 7.10.1 (Parser) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: | haddock/should_compile_flag_haddock/T10398 Blocked By: | Blocking: Related Tickets: | Differential Revisions: Phab:D1025 -------------------------------------+------------------------------------- Comment (by dmcclean): Thanks everyone! -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#10398: Support consecutive named Haddock comments -------------------------------------+------------------------------------- Reporter: dmcclean | Owner: Type: bug | Status: closed Priority: normal | Milestone: 8.0.1 Component: Compiler | Version: 7.10.1 (Parser) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: Other | Test Case: | haddock/should_compile_flag_haddock/T10398 Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1025 -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"6350eb1126e29b93829de688623c91b772f6d9eb/ghc" 6350eb1/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="6350eb1126e29b93829de688623c91b772f6d9eb" Handle multiline named haddock comments properly Fixes #10398 in a different way, thereby also fixing #11579. I inverted the logic of the Bool argument to "worker", to hopefully make it more self-explanatory. Reviewers: austin, hvr, bgamari Reviewed By: bgamari Differential Revision: https://phabricator.haskell.org/D1935 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/10398#comment:7> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC