Make it possible to hide details of strucures or inductive types in docstring rendering
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 384
- Forks
- 124
- Avg merge
- 22h 28m
- Merged PRs (30d)
- 10
Description
For example, ST.Ref's fields are really an internal implementation detail rather than part of the Lean API. It should be possible to suppress their display while still including the docstring for the type itself.
Contributor guide
No contributing guide indexed for this repository
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 tracing the docstring renderer's handling of structures and inductive types, using ST.Ref as the example. Done means callers can suppress field details while the type's docstring still renders, with behavior verified for both structures and inductive types.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100