docs(cli): -t/--type help never names the semantic filters
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
Research direction
Locate the /// doc comment for the -t/--type argument in big-code-analysis-cli/src/cli_args/, add a sentence listing the six semantic filters (all, function, call, comment, string, error) and reference the book section at commands/nodes.md#semantic-filters. Run cargo xtask to regenerate the man/ pages, then run make check-manpage-drift to confirm no drift. Done when the CLI help text includes the semantic filters and the man pages are updated with no drift.
Written by the indexing model from the issue text.
Description
Summary
The clap help for -t/--type on bca find and bca count reads
"Node-type name to match" and never mentions the six semantic filters
(all, function, call, comment, string, error) that the
option also accepts and that take precedence over an identically named
node type. Found in #1456, which defined them in the book
(commands/nodes.md#semantic-filters) but left the CLI text alone.
Fix
One or two sentences on the /// doc of the -t/--type argument in
big-code-analysis-cli/src/cli_args/, pointing at the book section.
Any edit to a clap /// must be followed by cargo xtask with the
regenerated man/ pages in the same commit
(make check-manpage-drift), and the text must carry no issue
reference (help_text_carries_no_issue_references pins this).
Related
- #1456
- Dominant language
- Rust
- Stars
- 32
- Forks
- 3
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 49
Getting set up
- Ships a 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 dekobon/big-code-analysis
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dekobon/big-code-analysis#1644 ·
Maintainers usually reply within 1 day
-
bug python vcs
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
dekobon/big-code-analysis#1624 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
dekobon/big-code-analysis#1484 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
dekobon/big-code-analysis#1458 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
dekobon/big-code-analysis#1444 ·
Maintainers usually reply within 1 day
All issues in dekobon/big-code-analysis
Similar issues
-
documentation priority:p2 type:chore
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
dispatch:sol-high documentation
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
carrick-sh/carrick#768 · 1 comment ·
Maintainers usually reply within 1 day
-
correctness postgres tursopg
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
tursodatabase/turso#10442 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
ankitects/anki#5864 · 1 reaction ·
Maintainers usually reply within 2 days
-
area: config effort: S good first issue P3 type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
ferenyl/azuredevopstui#63 ·