junegunn / junegunn/redis-stat
(README) add explicit documentation about the usage of INTERVAL and COUNT
Open
- Dominant language
- Ruby
- Stars
- 2k
- Forks
- 335
- PR merge metrics
- No merged PRs in 30d
Description
I went through the whole README and I couldn't find anything describing what those two options were doing. Is the interval given in seconds? What is that count exactly?
Contributor guide
No contributing guide indexed for this repository
Research direction
Read the README sections that describe the INTERVAL and COUNT options. Update the documentation to state whether INTERVAL is measured in seconds and explain exactly what COUNT controls; done means both options are explicitly and unambiguously described.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100