Incorrect `@since` annotations in `GHC.TypeError`
Summary
(I think that base-4.16 and GHC-9.2 are synonymous, as are base-4.17 and GHC-9.4, if not then this report may be incorrect)
Location of documentation issue: Haddocks of base
, changelog of base
GHC.TypeError
says @since 4.16.0.0
- in the module header (https://gitlab.haskell.org/ghc/ghc/-/blob/master/libraries/base/GHC/TypeError.hs#L15)
- on
type Assert
(https://gitlab.haskell.org/ghc/ghc/-/blob/master/libraries/base/GHC/TypeError.hs#L135)
Similarly, the changelog of base says, under "Documentation Fixes > 4.16.0.0"
Comparison constraints in Data.Type.Ord (e.g. <=) now use the new GHC.TypeError.Assert type family instead of type equality with ~.
Note that the changelog of base says (correctly in the 4.17 section)
Add GHC.TypeError module to contain functionality related to custom type errors. TypeError is re-exported from GHC.TypeLits for backwards compatibility.
Note these two changelog fragments are inconsistent wrt when this was introduced!
The PR that introduced the module and type was !6066 (closed), which only landed in GHC-9.4==base-4.17.0.0.
Proposed improvements or changes
I think the correct thing is
- Change these to
@since 4.17.0.0
- move the changelog entry up