From 69e243725f6c67a8cffa0936734866a171a99d7d Mon Sep 17 00:00:00 2001 From: Javed Habib <100477031+JaeAeich@users.noreply.github.com> Date: Thu, 30 May 2024 13:10:51 +0530 Subject: [PATCH] feat: add `pydocstyle` (#186) Co-authored-by: Alex Kanitz --- pyproject.toml | 15 ++++++++++++++- tesk/__init__.py | 4 +--- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 37ef7c8d..0fd83043 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,6 +52,9 @@ types-botocore = "^1.0.2" types-requests = "^2.31.0.20240406" types-urllib3 = "^1.26.25.14" +[tool.ruff.lint.pydocstyle] +convention = "google" + [tool.ruff.lint] select = [ "E", # pycodestyle @@ -60,9 +63,19 @@ select = [ "B", # flake8-bugbear "SIM", # flake8-simplify "I", # isort - "PL" # pylint + "PL", # pylint + "D" # pydocstyle +] +ignore = [ + "D203", # conflicts with D202 as formatter removes black line before class docstring + "D213", # conflicts with D212, would have been ignored regardless + "D206" # conflicts with E101, `format.indent-style="tab"` ] +[tool.ruff.lint.per-file-ignores] # ignore all pydocstyle errors in test and services modules +"tesk/services/**/*.py" = ["D"] +"tests/test_unit/test_services/**/*.py" = ["D"] + [tool.ruff.format] quote-style = "single" indent-style = "tab" diff --git a/tesk/__init__.py b/tesk/__init__.py index 168e28a8..a2cb116a 100644 --- a/tesk/__init__.py +++ b/tesk/__init__.py @@ -1,3 +1 @@ -""" -_summary_:tesk package initialization file. -""" +"""TESK package initialization file."""