docs(ux): clarify output flags and metric semantics in --help and README (closes #180)#186
Merged
Merged
Conversation
…DME (closes #180) - scan/summary/trace --help: add Notes epilog (RawDescriptionHelpFormatter) pointing at --format compact / --lite and (for scan) incremental behavior - README.md: add 'Interpreting signals' section after Impact Risk Levels (~10 lines): reference_count = popularity not criticality, trace --direction up to find callers, --format compact / --lite, first scan builds the graph - SKILL.md: add 'Reading the Output — Signal vs. Metric' table covering reference_count, status:dead, status:duplicate_ref, high_complexity + the same noise-reduction and incremental-scan notes
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Closes #180
What changed
scan --help,summary --help,trace --helpnow print aNotes:epilog (viaRawDescriptionHelpFormatter) pointing at--format compact/--lite, and (for scan) the incremental-vs-first-scan behavior.README.md: new## Interpreting Signalssection (4 bullets, ~10 lines) right afterImpact Risk Levels— explicitreference_count= popularity not criticality,trace --direction upto find callers,--format compact/--litefor noise reduction, first scan builds the SQLite graph.SKILL.md: new## Reading the Output — Signal vs. Metricsection betweenStatus & Flag ReferenceandIntegration with AI Agent— a 4-row table coveringreference_count,status: dead,status: duplicate_ref,high_complexity, plus the same noise-reduction + incremental-scan notes.CONTEXT.mdPR (separate repo):Wolfvin/worker-skills#<fill-in>adds a## How to read CodeLens outputsection with the same signal-vs-metric distinction in Indonesian (matching the rest of CONTEXT.md).Sebelum → Sesudah
scan --help: no Notes → 4-line Notes epilog mentioning incremental +--format compact/--litesummary --help: no Notes → 3-line Notes epilog mentioning--format compact/--lite/--detail minimaltrace --help: no Notes → 4-line Notes epilog mentioning direction +--format compact/--lite/ paginationHow this was verified
python3 scripts/codelens.py scan --helprenders epilog with preserved line breakspython3 scripts/codelens.py summary --helprenders epilogpython3 scripts/codelens.py trace --helprenders epilogpytest tests/test_cli.py::TestArgparseFormatConflictRegression— 4/4 pass (help-does-not-crash, command-count-does-not-crash, no-duplicate-f-in-subparsers, parser-construction-no-argparse-error)Findings (pre-existing, not from this PR)
tests/test_cli.py::test_scan_with_format_long_does_not_crashandtest_scan_with_format_short_does_not_crash: hit 60s subprocess timeout scanning CodeLens itself on this environment. Not argparse-related — the assertion would have passed if the scan completed. CI on a faster runner should be fine.tests/test_formatters_phase2.py::test_help_lists_new_formats: pre-existing failure (verified by stashing this PR and rerunning on main). The test runssecrets --format text --helpbuttextis not in the global--formatargparse choices — looks like a stale test or a separate bug, out of scope here.tests/test_codelensignore.py::TestBackwardCompat::test_actual_target_dir_is_ignored: pre-existing on main.tests/test_confidence.py::TestFormatterIntegration::test_json_format_has_schema_versionand 2 siblings: pre-existing on main (KeyError: schema_version).tests/test_adr.py::TestMcpToolRegistration::*(4 tests): pre-existing on main.tests/test_universal_grammar_loader.py::TestLoadGrammar::*(2 tests): pre-existing on main, network/install-related.test_lsp_server.py,test_rule_engine.py,test_rule_matcher.py: missing optional deps (lsprotocol,tree_sitter) on this box — environmental.KISS: stuck to DoD exactly — scan/summary/trace help + README section + CONTEXT.md. Did not touch
--formatchoices, the dispatcher, or other commands help text. CONTEXT.md update lives in a separate worker-skills PR (different repo).