rl-institut / rl-institut/simbev
Add code documentation
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Python
- Stars
- 13
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Tasks:
- Research docstring conventions
- Decide on convention that fits our needs (typing, readthedocs, ...)
- Write docstrings for existing classes and functions
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
No files, tests, or entry points are named. Locate the existing classes and functions in the project, review the chosen docstring convention, and document the remaining items. Done means the existing classes and functions have consistent docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100