[GHC] #15025: Lingering @since TODO Haddock annotations
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | 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: -------------------------------------+------------------------------------- There are currently a handful of `@since TODO` annotations in Haddocks throughout the core libraries that were probably intended to be replaced with a real version at some point, but managed to slip through the cracks into the GHC 8.4.1 release: * `FixIOException` in `base`: http://git.haskell.org/ghc.git/blob/270e3e9bbaabad3d9a1348cea9e46a9ecf1e5ec2... * `powModSecInteger` in `integer-gmp`: http://git.haskell.org/ghc.git/blob/270e3e9bbaabad3d9a1348cea9e46a9ecf1e5ec2... /integer-gmp/src/GHC/Integer/Type.hs#l1454 We should fix these before GHC 8.4.2. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: new Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578 Wiki Page: | -------------------------------------+------------------------------------- Changes (by RyanGlScott): * differential: => Phab:D4578 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: patch Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Changes (by RyanGlScott): * status: new => patch * differential: Phab:D4578 => Phab:D4578, Phab:D4586 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: patch Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"c4814ab6b8d756ae0e32c9a9f44e4888c4e24763/ghc" c4814ab6/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="c4814ab6b8d756ae0e32c9a9f44e4888c4e24763" Bump version numbers: base-4.11.1.0, integer-gmp-1.0.2.0 This takes care of bumping the `base` and `integer-gmp` minor version numbers in anticipation of a GHC 8.4.2 release. While I was in town, I also filled in a `@since TODO` Haddock annotation for `powModSecInteger` in `integer-gmp` with `1.0.2.0`, and updated the changelog accordingly. Test Plan: ./validate Reviewers: hvr, goldfire, bgamari Reviewed By: bgamari Subscribers: thomie, carter GHC Trac Issues: #15025 Differential Revision: https://phabricator.haskell.org/D4586 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: merge Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Changes (by RyanGlScott): * status: patch => merge -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: merge Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Comment (by Ryan Scott <ryan.gl.scott@…>): In [changeset:"ce27c7d5fe3c335dcc354b70fdfc17831a6848f6/ghc" ce27c7d/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="ce27c7d5fe3c335dcc354b70fdfc17831a6848f6" Correct FixIOException's @since annotation retroactively Summary: In D4113, a `FixIOException` data type was added with a `@since TODO` annotation, but it seems that `TODO` made it out into `base-4.11` itself. I've (retroactively) fixed this and added an entry to the `base-4.11` entry in the `changelog`. Test Plan: Read it Reviewers: dfeuer, hvr, bgamari Reviewed By: dfeuer Subscribers: thomie, carter GHC Trac Issues: #14356, #15025 Differential Revision: https://phabricator.haskell.org/D4578 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: merge Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Comment (by RyanGlScott): Both c4814ab6b8d756ae0e32c9a9f44e4888c4e24763 and ce27c7d5fe3c335dcc354b70fdfc17831a6848f6 ought to be merged. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#15025: Lingering @since TODO Haddock annotations -------------------------------------+------------------------------------- Reporter: RyanGlScott | Owner: (none) Type: bug | Status: closed Priority: high | Milestone: 8.4.2 Component: libraries | Version: 8.4.1 (other) | Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D4578, Wiki Page: | Phab:D4586 -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * resolution: => fixed Comment: Both merged to `ghc-8.4`. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/15025#comment:7> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC