Skip to content

Conversation

@zulquer
Copy link
Collaborator

@zulquer zulquer commented Dec 2, 2025

This pull request standardizes and simplifies docstrings throughout the codebase by converting multi-line docstrings to single-line format in both source and test files. This improves readability and consistency, especially for class and method documentation. Additionally, a minor change is made to the pyproject.toml configuration.

Docstring Standardization and Simplification:

  • Converted all multi-line docstrings to single-line docstrings for manager classes in the src/multisafepay/api/paths/ directory (e.g., AuthManager, CaptureManager, CategoryManager, etc.), improving code consistency and readability. [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Updated all test files to use single-line docstrings for test cases and helper classes, streamlining documentation and making tests easier to scan. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]

Configuration Update:

  • Removed "D200" from the ignore list in the extend-safe-fixes section of pyproject.toml, possibly to enforce stricter docstring formatting rules.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR standardizes docstring formatting across the codebase by converting multi-line docstrings to single-line format in compliance with the D200 ruff rule. The change affects both source and test files, improving consistency and readability.

Key changes:

  • Converted multi-line docstrings to single-line format for test functions and helper classes
  • Simplified class-level docstrings for manager classes in the API layer
  • Removed D200 from the ruff ignore list in pyproject.toml to enforce the new standard

Reviewed changes

Copilot reviewed 79 out of 79 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/multisafepay/unit/value_object/*.py Standardized test function docstrings to single-line format
tests/multisafepay/unit/util/*.py Converted multi-line test docstrings to single-line format
tests/multisafepay/unit/exception/*.py Simplified exception test docstrings
tests/multisafepay/unit/api/**/*.py Unified docstring format for API component tests
tests/multisafepay/integration/**/*.py Applied single-line docstrings to integration tests
src/multisafepay/api/paths/**/*_manager.py Converted manager class docstrings to single-line format
src/multisafepay/util/webhook.py Simplified Webhook class docstring
pyproject.toml Removed D200 from ruff ignore list to enforce formatting

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Dec 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.69%. Comparing base (28b36c4) to head (0a1f8f5).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #40   +/-   ##
=======================================
  Coverage   90.69%   90.69%           
=======================================
  Files         143      143           
  Lines        2471     2471           
=======================================
  Hits         2241     2241           
  Misses        230      230           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@danielcivit danielcivit merged commit 41f42f2 into master Dec 3, 2025
6 checks passed
@danielcivit danielcivit deleted the PTHMINT-90 branch December 3, 2025 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants