docs: correct stale analyzer status and dangling references#50
docs: correct stale analyzer status and dangling references#50AbhiramDwivedi wants to merge 2 commits into
Conversation
rng1995
left a comment
There was a problem hiding this comment.
Review: APPROVE
Accurate, low-risk documentation/comment cleanup that removes real sources of confusion. Each change checks out:
- The package-layout and "Stub analyzers" sections previously labeled the behavioral taint-tracking, MCP, and semantic analyzers as stubs; they're implemented, and the table now reflects that (TT/LP/TP rule families called out) while correctly keeping
mcp_rug_pullas the one remaining stub with planned rule IDs. This matches the actual analyzer behavior (e.g. the telemetry/coverage those analyzers carry), so the docs are no longer misleading about what runs. - Good catch fixing the
//comment in the Python example to#— the previous form is not valid Python and would mislead anyone copy-pasting the programmatic snippet. - Replacing the internal design-doc references in
graph.pywith neutral roadmap notes is the right call for a public repo, and the roadmap content is preserved in a form that doesn't point at a non-public document. The refreshed module docstrings are consistent with this.
Open-source hygiene — clean; no internal hostnames, tickets, or infra details introduced, and this actually reduces the repo's exposure of internal references.
Minor / optional (non-blocking)
- One more internal design-doc reference of the same style still lives in
src/skillspector/models.py(theAnalyzerPluginprotocol docstring). Since this PR is specifically sweeping those out, it'd be worth folding that one into the same cleanup so none remain.
No behavior change, nothing blocking. Approving.
…e semantic-analyzer doc Completes the internal-reference cleanup this PR started. The reviewer asked to fold in the remaining models.py case "so none remain"; grepping surfaced several more, all neutralized here while preserving meaning: - models.py: AnalyzerPlugin docstring describes the protocol instead of citing the internal spec section. - behavioral_taint_tracking.py (+ its test): cite the public rule family (TT1-TT5) rather than the internal section number. - mcp_rug_pull.py: keep the RP1-RP3 roadmap TODO, drop the internal-doc pointer. - semantic_developer_intent.py / semantic_quality_policy.py: drop section numbers from the module docstrings. - tests/nodes/analyzers/test_registry.py: reword docstrings/comment and rename test_analyzer_node_ids_match_sadd_spec -> test_analyzer_node_ids_match_expected. - docs/LLM_ANALYZER_BASE_GUIDE.md: the "Semantic Analyzer Stubs" table both called the now-implemented semantic analyzers stubs "ready to be implemented" and carried a "SADD Reference" column. Retitle to "Semantic Analyzers", note they emit only when use_llm is enabled, and drop the internal-reference column -- consistent with the DEVELOPMENT.md correction in this PR. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Ram Dwivedi <abhiram.dwivedi@yahoo.com>
|
@rng1995 Thanks! Folded the I also caught a related stale claim in the same spirit as this PR: the "Semantic Analyzer Stubs" table in |
|
Please resolve merge conflicts |
rng1995
left a comment
There was a problem hiding this comment.
[Automated SkillSpector Review]
Re-review — re-confirming approval.
Docs/comment-only, no behavior change. My one non-blocking nit from the first pass (the residual SADD reference in models.py's AnalyzerPlugin docstring) was folded in, along with a thorough sweep of the remaining internal design-doc references and a corrected "Semantic Analyzers" table in the LLM guide. All edits are accurate (taint tracking is TT1-TT5; mcp_rug_pull correctly remains the one stub). Approving.
Signed-off-by: Ram Dwivedi <abhiram.dwivedi@yahoo.com> # Conflicts: # src/skillspector/nodes/analyzers/mcp_rug_pull.py # tests/nodes/analyzers/test_registry.py
|
@rng1995 Resolved against the latest One thing worth flagging: |
Closes #55
What
Documentation/comment-only corrections — no behavior change.
docs/DEVELOPMENT.mddescribed the MCP, semantic, and taint-tracking analyzers as "stubs"; they are implemented. Updated the package-layout and "Stub analyzers" sections to reflect actual status.mcp_rug_pullis correctly kept as the one remaining stub (RP1–RP3 planned).//comment in the Python example in DEVELOPMENT.md.graph.pywith neutral roadmap notes (the SADD design doc isn't in the public repo).Test
No code changes; lint and the unit suite are unaffected.
🤖 Generated with Claude Code