PTHMINT-52: Fix Ruff D100 #33
Conversation
| # See the DISCLAIMER.md file for disclaimer details. | ||
|
|
||
|
|
||
| """Value object for Test Unit Ip Address data.""" |
There was a problem hiding this comment.
Capitalization issue in 'Ip Address' - should be 'IP Address'.
| """Value object for Test Unit Ip Address data.""" | |
| """Value object for Test Unit IP Address data.""" |
| # See the DISCLAIMER.md file for disclaimer details. | ||
|
|
||
|
|
||
| """Value object for Test Unit Iban Number data.""" |
There was a problem hiding this comment.
Capitalization issue in 'Iban Number' - should be 'IBAN Number'.
| """Value object for Test Unit Iban Number data.""" | |
| """Value object for Test Unit IBAN Number data.""" |
| @@ -1,0 +1 @@ | |||
| """Integration tests for creating refund requests via the order manager.""" | |||
There was a problem hiding this comment.
File name contains typo 'integrationa' which should be 'integration'.
| # This file is licensed under the Open Software License (OSL) version 3.0. | ||
| # For a copy of the license, see the LICENSE.txt file in the project root. | ||
|
|
||
| # See the DISCLAIMER.md file for disclaimer details.v |
There was a problem hiding this comment.
Stray 'v' character at the end of the disclaimer comment.
| # See the DISCLAIMER.md file for disclaimer details.v | |
| # See the DISCLAIMER.md file for disclaimer details. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #33 +/- ##
=======================================
Coverage 90.53% 90.53%
=======================================
Files 107 107
Lines 2334 2334
=======================================
Hits 2113 2113
Misses 221 221 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
danielcivit
left a comment
danielcivit
left a comment
There was a problem hiding this comment.
Read this twice just to check if the descriptions are wrong in any of these files, but beyond that point I am not going to review this. There is no impact, even if there is an error on any description.
This pull request adds descriptive module-level docstrings to many files in the MultiSafepay Python SDK, improving code readability and maintainability. These docstrings clarify the purpose of each module, making the codebase easier to navigate for both current and future developers. Additionally, a minor configuration change was made to the linter settings.
Module documentation improvements:
src/__init__.py,src/multisafepay/__init__.py, and various API management and response modules, to clarify their roles in the SDK. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]Linting configuration:
pyproject.tomlto removeD100from the ignore list, ensuring that top-level docstring checks are now enforced.