Skip to content

chore: add .coderabbit.yaml to silence the docstring-coverage pre-merge check#77

Merged
PhysShell merged 1 commit into
mainfrom
claude/coderabbit-config
Jun 22, 2026
Merged

chore: add .coderabbit.yaml to silence the docstring-coverage pre-merge check#77
PhysShell merged 1 commit into
mainfrom
claude/coderabbit-config

Conversation

@PhysShell

@PhysShell PhysShell commented Jun 22, 2026

Copy link
Copy Markdown
Owner

Adds .coderabbit.yaml to 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:

  • the C# Roslyn extractor (frontend/roslyn/**) carries a // line-comment doc block above every helper — the file's established house style, deliberately not /// XML doc comments;
  • the Python core and tooling (ownlang/**, scripts/**, tests/**) already carry module- and function-level docstrings;
  • the corpus (corpus/**) is hand-written .cs / .own reductions — 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.

reviews:
  pre_merge_checks:
    docstrings:
      mode: "off"

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

  • Chores
    • Updated CI/pre-merge validation configuration to adjust coverage check requirements.

…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
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 208be556-1fa0-41f3-a71e-0fcb269f88d3

📥 Commits

Reviewing files that changed from the base of the PR and between 3b6dd4b and 5a52c91.

📒 Files selected for processing (1)
  • .coderabbit.yaml

📝 Walkthrough

Walkthrough

The .coderabbit.yaml configuration file is updated to disable the pre-merge docstrings coverage check by setting reviews.pre_merge_checks.docstrings.mode to "off". No code logic or other configuration is changed.

Changes

CodeRabbit Configuration Update

Layer / File(s) Summary
Turn off pre-merge docstrings mode
.coderabbit.yaml
reviews.pre_merge_checks.docstrings.mode is set to "off", disabling the docstring coverage gate in pre-merge checks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A bunny hopped through the config one day,
And flipped a small switch to send docstrings away.
"No more pre-merge checks blocking my run!"
The rabbit declared — and the pipeline said "Done!"
With one little off, the CI hops on. 🌿

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the primary change: adding a .coderabbit.yaml configuration file to disable the docstring-coverage pre-merge check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/coderabbit-config

Comment @coderabbitai help to get the list of available commands and usage tips.

@PhysShell
PhysShell merged commit 5b31c36 into main Jun 22, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants