PEP 257 enabled#110
Merged
Merged
Conversation
… 257 Docstring Conventions); linting
skupriienko
added a commit
to oss-repack/mailjet-apiv3-python
that referenced
this pull request
May 5, 2025
* docs: Add docstrings for packages, modules, classes, methods, and functions (following PEP 257 Docstring Conventions); apply linting * docs: Enable docstring lints * docs: Remove Return: None * docs: Remove unused or fixed ruff lint rules * ci: update pre-commit hooks * docs: Add more docstring to tests * docs: pydocstyle linting
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
1 participant
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.
Enable PEP 257 – Docstring Conventions
Actions:
Add missing
docstringsto:ruff check . --preview,pydocstyle .andpre-commit run --all-filessamplesfolder by keeping samples compactAdditional fixes:
test.pyReturn: Nonefrom docstrings as it's not recommended; see https://docs.astral.sh/ruff/rules/docstring-extraneous-returns/rufflint rulesAPI_REFby usinghttpsinstead ofhttp.