pydocstyle implementation - Merge pull request #546 from iKostanOrg/master #547
Conversation
This file contains 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
Merge from master
ikostan
added
documentation
Reviewer's Guide by SourceryThis PR implements pydocstyle configuration and GitHub Actions workflow for the kyu2 branch. It adds docstring validation for the kyu_2 package and sets up automated documentation style checking. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
We have skipped reviewing this pull request. Here's why:
- We don't review packaging changes - Let us know if you'd like us to change this.
- All of the files are larger than we can process. We're working on it!
|
Code Climate has analyzed commit 92981fe and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 90.0% (0.0% change). View more on Code Climate. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #547 +/- ##
=======================================
Coverage 90.06% 90.06%
=======================================
Files 172 172
Lines 2587 2587
=======================================
Hits 2330 2330
Misses 257 257 ☔ View full report in Codecov by Sentry. |
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @ikostan - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider expanding pydocstyle checking to cover the entire codebase rather than just kyu2. This would ensure consistent documentation standards across the project.
- The .pydocstyle configuration file appears to be empty. Please add appropriate configuration to define which docstring standards you want to enforce.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
kyu_2/evaluate_mathematical_expression/evaluate.py:15 in public function `calculate`:
D205: 1 blank line required between summary line and description (found 0)
Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description. The summary line may be used by automatic indexing tools;
it is important that it fits on one line and is separated from the
rest of the docstring by a blank line.
kyu_2/evaluate_mathematical_expression/evaluate.py:15 in public function `calculate`:
D400: First line should end with a period (not 'n')
The [first line of a] docstring is a phrase ending in a period.
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
./kyu_2/evaluate_mathematical_expression/evaluate.py:175:1: W293 blank line contains whitespace
"""
Normalizing string input by checking conditions.
:param strings: list
:param string: str
:param temp: str
:return: tuple(str, str)
"""
kyu_2/evaluate_mathematical_expression/evaluate.py:79 in public function `process_brackets`:
D205: 1 blank line required between summary line and description (found 0)
Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description. The summary line may be used by automatic indexing tools;
it is important that it fits on one line and is separated from the
rest of the docstring by a blank line.
kyu_2/evaluate_mathematical_expression/evaluate.py:79 in public function `process_brackets`:
D400: First line should end with a period (not 't')
The [first line of a] docstring is a phrase ending in a period.
kyu_2/evaluate_mathematical_expression/evaluate.py:173 in public function `check_conditions`:
D401: First line should be in imperative mood (perhaps 'Normalize', not 'Normalizing')
[Docstring] prescribes the function or method's effect as a command:
("Do this", "Return that"), not as a description; e.g. don't write
"Returns the pathname ...".
Thanks |
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.
Merge from master + pydocstyle implementation
Summary by Sourcery
CI: