Closed cclauss closed 9 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
b85d900
) 80.92% compared to head (68bdd10
) 80.92%.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Issues
0 New issues
Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code
I think we should remove the docstrings about function complexity, Sonarcloud.io already give us information on that which is better in my opinion and you can check here for more details. When we get code that is too complex on a PR the Sonarcloud.io bot the dashboard seems to notify us about it. The docstring from ruff my stay in the code even after we fix the issue and make things even harder to maintain later on, also, it adds to the number of duplicated lines. The rest of the PR looks good tho and I think it will be a good addition since it will let people know about any issue before they even commit the code to their repo.
If a contributor comes to modify one of these functions, the docstrings will alert them before they attempt to make modification. SonarCloud would only warn them after they have already made modifications. The # noqa
linter directives on these functions are not self-documenting unless contributors have memorized these directives so the docstrings provide in-situ documentation.
If a tool is asserting that lines in docstrings are duplicate code then that rule should be disabled.
If a contributor comes to modify one of these functions, the docstrings will alert them before they attempt to make modification. SonarCloud would only warn them after they have already made modifications. The
# noqa
linter directives on these functions are not self-documenting unless contributors have memorized these directives so the docstrings provide in-situ documentation.If a tool is asserting that lines in docstrings are duplicate code then that rule should be disabled.
mmm, you are right, then, I will merge this PR and see if today I can reduce the code complexity on these files and a few others.
Description
pre-commit: Add more ruff rules This sets some upper limits on code complexity to increase the maintainability of the code.
Please include:
Closes: # (issue)
Checklist: