docs/tools: address PR #391 CodeRabbit findings; add advisory MD029 markdownlint check - #392
Conversation
Item 7's own entry never noted that the conda_avail mechanism it introduced was later found broken and reverted -- a future reader could follow it as still-valid guidance. Added an in-place correction paragraph cross-referencing item 15. Also fixed the MD029 ordered-list warning: item 15 was a second "N." marker in the same implicit ordered list as item 7, with non-sequential numbers. Converted to a bullet with "Active Backlog item 15" spelled out in the bold lead sentence, matching how every other historical item number in this doc is referenced in prose. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015xbWLPbiaKVsobB9FZy8kS
CodeRabbit's MD029 finding on PR #391 (a stray literal "15." collided with CLAUDE.md's own Active Backlog stable-ID convention) was real but would have been just as easy to reintroduce next time -- add a narrow, advisory-only check to catch it locally before push instead of relying on a reviewer bot each time. Deliberately scoped to MD029 only, on CLAUDE.md only: a full default markdownlint pass produces ~2700 hits on CLAUDE.md alone (~99% MD013 line-length, a rule this repo has never followed), and README.md/docs/*.md use their own unreviewed numbering schemes. Never fails the sweep -- matches PYFLAKES's own established advisory-only precedent. Documents the underlying convention (bullets with the number in prose for new Active Backlog items, not literal "N." markers) in AGENTS.md so it's discoverable outside the lint config's own comments. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015xbWLPbiaKVsobB9FZy8kS
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (8)
🧰 Additional context used📓 Path-based instructions (3)**/*📄 CodeRabbit inference engine (AGENTS.md)
Files:
CLAUDE.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
🧠 Learnings (1)📓 Common learnings🔇 Additional comments (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds advisory MD029-only Markdown linting to the sanity sweep and documents the ChangesMarkdown linting
Conda CI correction documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CLAUDE.md`:
- Around line 747-750: Update the referenced GitHub Actions evidence in
CLAUDE.md to use the actual numeric workflow run IDs for the API checks, or
explicitly relabel efd7a5c and fd7a046 as commit SHAs instead of run IDs. Keep
the PR and step details unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: e26c5cdf-b789-4217-9baf-f3b6f000d1fc
📒 Files selected for processing (4)
.markdownlint-cli2.jsoncAGENTS.mdCLAUDE.mdtools/run_sanity_sweep.sh
📜 Review details
⏰ Context from checks skipped due to timeout. (9)
- GitHub Check: auto_merge
- GitHub Check: Batch syntax/run check (cache)
- GitHub Check: Batch syntax/run check (uv-dl-fallback)
- GitHub Check: Batch syntax/run check (real)
- GitHub Check: Batch syntax/run check (contract-uv-fail)
- GitHub Check: Batch syntax/run check (uv)
- GitHub Check: Batch syntax/run check (contract-uv)
- GitHub Check: Batch syntax/run check (conda-full)
- GitHub Check: Batch syntax/run check (justme-test)
🧰 Additional context used
📓 Path-based instructions (3)
**/*
📄 CodeRabbit inference engine (AGENTS.md)
**/*: Follow Plan -> Check the plan -> Execute -> Self-check/tests; make minimal surgical changes and test before submission.
Push every commit before it can be lost; after each push, wait for CI, fix failures before proceeding, and do not open a PR until the final commit is green and diagnostics are verified.
**/*: Update the relevant knowledge document in the same commit when a change teaches or invalidates a lesson:docs/agent-interconnect.md,docs/agent-lessons-learned.md, ordocs/agent-ndjson.md.
Before every commit, run the repository sanity sweep, including Python compilation/linting, delimiter checks, workflow linting, PowerShell parsing, and pytest; extend the ASCII file list to cover touched files.
Files:
tools/run_sanity_sweep.shAGENTS.mdCLAUDE.md
**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
Cite
run_setup.batlocations by label or subroutine name rather than line number in documentation.
Files:
AGENTS.mdCLAUDE.md
CLAUDE.md
📄 CodeRabbit inference engine (AGENTS.md)
Run the advisory MD029-only Markdown lint for
CLAUDE.md; new Active Backlog items must be bullets with the number in prose, not literal ordered-list markers.
Files:
CLAUDE.md
🔇 Additional comments (5)
.markdownlint-cli2.jsonc (1)
1-37: LGTM!AGENTS.md (2)
243-243: LGTM!
259-261: LGTM!tools/run_sanity_sweep.sh (1)
90-108: 🗄️ Data Integrity & IntegrationNo NDJSON/artifact wiring needed here.
tools/run_sanity_sweep.shis a local sanity helper, not a CI step, so this new advisory markdownlint check does not need an NDJSON row or abatch-check.ymltest-logs upload path.> Likely an incorrect or invalid review comment.CLAUDE.md (1)
709-724: LGTM!
CodeRabbit finding on PR #392: CLAUDE.md's Active Backlog item 15 called these two "real runs" when they're actually the commit SHAs whose CI runs were checked via the GitHub Actions API -- ambiguous wording, not a factual error in the underlying evidence. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015xbWLPbiaKVsobB9FZy8kS
Summary
Two small follow-ups held back while PR #391's CI was in-flight (never push while a run is in-flight -- would cancel it), now rebased onto
mainpost-merge.06e5b35):conda_availmechanism was later found broken (see item 15) -- item 7's own entry never mentioned this.15.ordered-list marker to a bullet with the number spelled out in prose, since CLAUDE.md's Active Backlog uses numbers as stable cross-referenced identifiers, not literal sequential list order -- a literal15.collides with markdown's own ordered-list renumbering rules..markdownlint-cli2.jsonc(repo root): disables every rule exceptMD029(ordered-list-item-prefix), scoped toCLAUDE.mdonly. A full default pass produces ~2700 hits onCLAUDE.mdalone (~99% line-length, a rule this repo has never followed); README.md/docs/*.md use their own unreviewed numbering schemes.check_markdownlint()step intools/run_sanity_sweep.sh, wired in right after the delimiter check. Never fails the sweep (matchescheck_pyflakes()'s own established advisory-only precedent).N.reserved for the historically-grandfathered item 7) in AGENTS.md, alongside themarkdownlint-cli2npm install instructions.Test plan
python -m compileall -q .python tools/check_delimiters.py run_setup.batmarkdownlint-cli2 CLAUDE.md(exactly the expected 1 permanent baseline finding -- item 7's own solo "7.")python -m yamllint .github/workflows/actionlint -oneline .github/workflows/*.ymlpython -m pytest tests/test_*.py -q(437 passed, 2 skipped)tools/run_sanity_sweep.shrun, all checks OKClaude-Session: https://claude.ai/code/session_015xbWLPbiaKVsobB9FZy8kS
Generated by Claude Code