docs: address PEP 257 docstring conventions across the codebase#760
Merged
Conversation
for more information, see https://pre-commit.ci
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
| return "" | ||
|
|
||
| else: | ||
| print("\n" + "API key: " + api_key + "\n") |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
__init__methods to improve code clarity and satisfy D105/D107 rules.Description
__init__,__str__,__repr__,__eq__,__lt__,__iter__) and other constructors across the codebase to address D105/D107 violations.Testing
ruff check colrev --select D --statisticsandruff check colrev --select D --fix, which substantially reduced docstring violations from roughly 520 to ~193 D-rule issues and applied all available auto-fixes.pytest -q, but the test run failed in this environment with an import path/module resolution error (ModuleNotFoundError: No module named 'colrev'), so the full test-suite could not be executed here.Codex Task