dts: add docstring checker

Python docstrings are the in-code way to document the code. The docstring checker of choice is pydocstyle which we're executing from Pylama, but the current latest versions are not complatible due to [0], so pin the pydocstyle version to the latest working version. [0] klen/pylama#232 Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech> Signed-off-by: 0-day Robot <robot@bytheb.org>
ovsrobot · Nov 6, 2023 · 3b1d823 · 3b1d823
1 parent 1a6c8d3
commit 3b1d823
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/dts/poetry.lock b/dts/poetry.lock
diff --git a/dts/pyproject.toml b/dts/pyproject.toml
@@ -25,6 +25,7 @@ PyYAML = "^6.0"
 types-PyYAML = "^6.0.8"
 fabric = "^2.7.1"
 scapy = "^2.5.0"
+pydocstyle = "6.1.1"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^0.961"
@@ -39,10 +40,13 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.pylama]
-linters = "mccabe,pycodestyle,pyflakes"
+linters = "mccabe,pycodestyle,pydocstyle,pyflakes"
 format = "pylint"
 max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length
 
+[tool.pylama.linter.pydocstyle]
+convention = "google"
+
 [tool.mypy]
 python_version = "3.10"
 enable_error_code = ["ignore-without-code"]