Increasing utilities quality and documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17.7k
- Forks
- 2.3k
- Avg merge
- 1d 30m
- Merged PRs (30d)
- 18
Description
The existing utilities are here to stay, but are feature complete. This needs to be documented, the doc strings need updating, the typing need checking, the test coverage is incomplete. Some also need notes points to projects that have fuller versions of what we have like TQDM, Rich, Prompt Toolkit, and others. This would be a good issue for someone that I have met at a python meetup to start with if they have a desire to contribute in a more long term way.
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 file or test path is named. Start by inventorying the existing utilities and their current test coverage, then review their docstrings and typing; done means the utilities are documented, typing is checked, missing tests are added, and notes mention fuller alternatives such as TQDM, Rich, and Prompt Toolkit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100