Doc on progress reporter
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 540
- Forks
- 106
- PR merge metrics
- No merged PRs in 30d
Description
I often find myself confused or second-guessing the meaning of the progress reporter output. It would be great to either have:
- A line printing its meaning be output before the progress reporter starts, or;
- A detailed doc in the usage text
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
The issue names the progress reporter and usage text but no files. Locate the progress reporter entry point and the usage text, then determine which output meaning is unclear. Done means users can understand the reporter output through a preface line or detailed usage documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100