Repository navigation
fix: require a linked directory to have a README and every public nam… #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json | ||
| reviews: | ||
| pre_merge_checks: | ||
| docstrings: | ||
| # Docstring Coverage is scored over the whole diff against a single | ||
| # percentage threshold, and the schema gives it no per-path option: | ||
| # `mode` and `threshold` are all it takes. What it cannot see is that | ||
| # pyproject.toml's own ruff config *deliberately* ignores D100-D104 | ||
| # and D107 (missing docstrings) under tests/*, matching the two | ||
| # sibling repos: every test here is named for what it asserts rather | ||
| # than carrying a docstring that restates that name. Leaving this | ||
| # check on therefore fights that convention on every PR that adds | ||
| # tests -- which is most of them -- for no gain, since coverage of | ||
| # src/ is already enforced by ruff's pydocstyle rules in the gate | ||
| # (./scripts/pre-commit-test.sh), which IS path-aware. | ||
| mode: "off" | ||
| # The exclusion the check above cannot express, stated where it *is* | ||
| # path-scoped: the reviewer. This holds whether or not that check is ever | ||
| # switched back on. | ||
| path_instructions: | ||
| - path: "tests/**" | ||
| instructions: >- | ||
| Do not ask for docstrings on test functions, methods or classes. | ||
| `[tool.ruff.lint.per-file-ignores]` in pyproject.toml ignores | ||
| D100-D104 and D107 under tests/* on purpose: each test is named for | ||
| the behaviour it pins, and a docstring restating that name is noise. | ||
| The test modules do carry a docstring, and a comment explaining what | ||
| a test is proving is welcome where the name alone does not carry it. | ||
| Docstrings ARE required in src/, where ruff's pydocstyle rules | ||
| enforce them. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: ctrondlp/python-libei
Length of output: 5711
Check exact documentation links, not text substrings.
assert name in textaccepts plain-text mentions and names embedded in longer identifiers, such asErrormatchingPortalError. Parse Markdown links and require an exact public-name label with a valid page target.🤖 Prompt for AI Agents