Mention ANSI colour codes in manpage (documentation)
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- perl
- Domain
- documentation
Research direction
Read the manpage text in the ack file at lines 2049–2061. Update it to mention that (on_)?ANSI\d+ is valid for --color-<item>, or direct users to Term::ANSIColor for the supported colour codes; it is done when the documentation makes this support discoverable.
Written by the indexing model from the issue text.
Description
Change request: Update the documentation at https://github.com/beyondgrep/ack3/blob/11d698f9407c6bd5dfcff1c264bf0aa60abacc5d/ack#L2049-L2061 to either
- mention that
(on_)?ANSI\d+is valid inside--color-<item>, or, - refer the user to Term::ANSIColor for a full list of supported colour codes
Context
Ack supports ANSI codes for --color-<type>, see e.g. https://github.com/beyondgrep/ack3/pull/407#issuecomment-6088778059
Discoverability is poor. (Anecdote below the fold.)
E.g. I came here to raise an feature request for ANSI input, not seeing it the latest manpage.
(Because the functionality is provided by a third party library, my amateur code search failed to spot that there was a dispatch. In my naivete I skimmed over the relevant line, thinking $ENV wasn't affected by command line flags 😓 )
I speculate that #407 had a similar origin story.
My typical use case: I have known ANSI colour codes (from e.g. editor configs) I want to copy, and
(n - 16) in base 6 and vice versa adds a lot of friction.
- Dominant language
- Perl
- Stars
- 833
- Forks
- 77
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from beyondgrep/ack3
-
docs
Difficulty 1/5 Under an hour Newbie friendliness 62/100
beyondgrep/ack3#147 · 2 reactions ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
beyondgrep/ack3#82 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 15/100
beyondgrep/ack3#408 ·
-
Loosing unicode filenamesMay be free again @n1vux claimed this 39 days ago, and no pull request is open. Open
Difficulty 3/5 1-2 days Newbie friendliness 65/100
beyondgrep/ack3#405 · 8 comments · 1 assignee ·
-
Add --nosortMay be free again @petdance claimed this 57 days ago, and no pull request is open. Open
beyondgrep/ack3#403 · 1 comment · 1 assignee ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
virtualmin/virtualmin-gpl#1322 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
easy first-contributor first-contributors good first issue help wanted perl shell up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 88/100
fork-commit-merge/fork-commit-merge#8461 ·
Maintainers usually reply within 1 day
-
PostgreSQL::Version rejects documented full psql version outputPossibly taken @feitiansiyan claimed this 1 day ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
IvorySQL/IvorySQL#2999 · 1 comment ·
Maintainers usually reply within 1 day
-
1.severity: security
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day