alan-turing-institute / alan-turing-institute/ReadabiliPy
Improve/generate documentation
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 359
- Forks
- 44
- PR merge metrics
- No merged PRs in 30d
Description
In #86 @GjjvdBurg added some code that would auto-generate documentation. We should tidy up/add documentation about how to use this package so that those docs are useful.
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 reviewing issue #86 and the documentation auto-generation code it introduced, then inspect the package's current user-facing documentation. Clarify which usage instructions are missing or unclear. Done means the generated documentation and package-usage guidance are tidy and useful.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100