leanprover / leanprover/reference-manual
Explicitly describe recurring API patterns
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
There are a number of patterns that occur multiple times in Lean, such as having a type class that represents the transitive closure of some other class (MonadLift vs MonadLiftT, MonadEval vs MonadEvalT, the various chainings of Coe*).
It would be useful to name these patterns and document their design considerations explicitly, rather than having multiple similar descriptions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the recurring patterns named in the issue: MonadLift/MonadLiftT, MonadEval/MonadEvalT, and the Coe* chainings. Identify where these patterns are currently described in the reference manual, then document shared names and design considerations; done means each cited pattern is covered consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100