Skip to content

Commit 5b31c36

Browse files
authored
Merge pull request #77 from PhysShell/claude/coderabbit-config
chore: add .coderabbit.yaml to silence the docstring-coverage pre-merge check
2 parents eef2e0c + 5a52c91 commit 5b31c36

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

‎.coderabbit.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
#
3+
# CodeRabbit configuration — https://docs.coderabbit.ai/guides/configure-coderabbit
4+
#
5+
# The "Docstring Coverage" pre-merge check measures docstring-style coverage across
6+
# the WHOLE PR diff and reports a false ~0% on this repo, because Own.NET documents
7+
# to its own conventions rather than the ones that heuristic counts:
8+
# * the C# Roslyn extractor (frontend/roslyn/**) carries a `//` line-comment doc
9+
# block above every helper — the file's established house style, deliberately
10+
# NOT `///` XML doc comments (adding them would break that consistency for a
11+
# metric);
12+
# * the Python core and tooling (ownlang/**, scripts/**, tests/**) already carry
13+
# module- and function-level docstrings;
14+
# * the corpus (corpus/**) is hand-written `.cs` / `.own` REDUCTIONS — terminal
15+
# demonstration fixtures, not an authored API surface to document.
16+
#
17+
# So turn the check off rather than chase coverage on it. ("off" is quoted so YAML
18+
# keeps it a string instead of the boolean false.)
19+
reviews:
20+
pre_merge_checks:
21+
docstrings:
22+
mode: "off"

0 commit comments

Comments
 (0)