chore: add .coderabbit.yaml to silence the docstring-coverage pre-merge check#77
Conversation
…ge check CodeRabbit's "Docstring Coverage" pre-merge check measures the whole PR diff and reports a false ~0% on this repo: the C# Roslyn extractor documents with `//` line-comment blocks (the file's house style, not `///` XML docs), the Python core and tooling already carry docstrings, and the corpus is hand-written `.cs`/`.own` reductions rather than an authored API surface. Retrofitting `///` to satisfy the metric would break the C#'s consistent `//` style, so turn the advisory check off. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe ChangesCodeRabbit Configuration Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Adds
.coderabbit.yamlto turn off CodeRabbit's Docstring Coverage pre-merge check, which has been reporting a false ~0% as an advisory ❌ on recent PRs (#75, #76).The check measures docstring-style coverage across the whole PR diff, but Own.NET documents to its own conventions, not the ones the heuristic counts:
frontend/roslyn/**) carries a//line-comment doc block above every helper — the file's established house style, deliberately not///XML doc comments;ownlang/**,scripts/**,tests/**) already carry module- and function-level docstrings;corpus/**) is hand-written.cs/.ownreductions — terminal demonstration fixtures, not an authored API surface.Retrofitting
///onto the C# to satisfy the metric would break that consistent//style, so the advisory check is turned off rather than chased.Config-only; verified it parses (
docstrings.mode == "off", a string). No code or CI changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
Generated by Claude Code
Summary by CodeRabbit