athityakumar / athityakumar/colorls
-r option not accurately documented
Open
Documentation
Hacktoberfest
Up-For-Grabs
- Dominant language
- Ruby
- Stars
- 5.1k
- Forks
- 396
- PR merge metrics
- No merged PRs in 30d
Description
### Description
macOS v. 10.13.4
Using `Terminal.app`
Report displays properly with `--report`, but not `-r`. Here's the relevant documentation.
- Relevant Issues : (none)
- Relevant PRs : (none)
- Type of issue :
- [x] Documentation
Contributor guide
Research direction
Inspect the CLI documentation for the `-r` and `--report` options and compare the wording with the behavior shown in the issue. Update the `-r` documentation so it accurately describes the option, then verify that both forms are documented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100