haskellfoundation / haskellfoundation/haskell-2010-revised-report

Move documentation of deriving of `Ix` instances into the report

Open Beginner friendly
#12 0 comments 0 reactions 0 assignees View on GitHub
feature: language report feature: standard libraries
Dominant language
Typst
Stars
20
Forks
5
Avg merge
4d 18h
Merged PRs (30d)
6

Description

Currently, the specification of derived instances of the `Eq, Ord, Bounded, Enum, Show, Read` typeclasses lives in a chapter in the language report, whereas the documentation of derived instances of the `Ix` typeclass is part of the library report.

This is partly justified by the fact that `Ix` is not part of the Prelude, but otherwise there does not seem to be a good reason for this organization choice. Since we probably want to specify extensions such as `DeriveFunctor`, `DeriveFoldable` etc. in future versions of the report, I think it would make more sense to document all `stock` deriving strategies in one place in the report.

Contributor guide

Open the contributing guide

Research direction

Locate the language-report chapter covering derived Eq, Ord, Bounded, Enum, Show, and Read instances, then find the current Ix deriving documentation in the library report. Move the Ix specification into the language report alongside the other stock deriving strategies; done when the Ix documentation is no longer maintained in the library report and the report remains coherent.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.