Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from darglint to pydoclint #232

Merged
merged 2 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .darglint

This file was deleted.

9 changes: 7 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,21 @@ repos:
- id: cspell
name: Spell check with cspell

# untill ruff has parity with darglint
- repo: https://github.com/PyCQA/flake8.git
rev: 6.1.0
hooks:
- id: flake8
language_version: python3
additional_dependencies:
- darglint
- flake8-docstrings

- repo: https://github.com/jsh9/pydoclint
rev: 0.3.4
hooks:
- id: pydoclint
args:
- "--config=pyproject.toml"

- repo: https://github.com/pycqa/pylint.git
rev: v3.0.1
hooks:
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ write_to = "src/tox_ansible/_version.py"
[tool.black]
line-length = 100

[tool.pydoclint]
allow-init-docstring = true
arg-type-hints-in-docstring = false
check-return-types = false
style = 'google'

[tool.pylint]

[tool.pylint.format]
Expand Down