leanprover / leanprover/reference-manual
How to write a correct `Repr` instance?
Open
Nobody has claimed this yet.
doc-request
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
What question should the reference manual answer?
What's the right way to implement reprPrec such that the resulting pretty printer is correct? Which library functions are useful for this task?
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 locating the reference manual sections covering the Repr instance and reprPrec, then review how related pretty-printer guidance is presented. Document the correct implementation approach and identify the useful library functions, with enough detail for readers to determine whether their resulting pretty printer is correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100