leanprover-community / leanprover-community/iris-lean
Add docstrings
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Lean
- Stars
- 218
- Forks
- 63
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 22
Description
Most of our code is not documented. Adding docstrings would help new users get familiar with Iris.
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
The issue does not identify files, modules, or entry points. Start by surveying the Lean 4 source to determine which public code lacks docstrings and clarify the intended scope with the maintainers. Done should mean the agreed code has useful docstrings and the project checks still pass.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100