dataforcanada/d4c-service-geo-assistant
1
0
Fork 0
mirror of https://github.com/dataforcanada/d4c-service-geo-assistant.git synced 2026-06-15 15:31:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

Enable pydocstyle (D) ruff rule and add more docs (#21)

Browse Source 
* Use pydocstyle (D) rule with google convention

Add a ruff rule to catch missing documentation. Using google convention so that undocumented-param (D417) rule is enabled to catch missing params, xref https://docs.astral.sh/ruff/rules/undocumented-param. Extended to include D213 (instead of D212) and D410 rules too.

* Fix D100 Missing docstring in public module

* Fix D101 Missing docstring in public class

* Fix D103 Missing docstring in public function

Also ignore rule D205 to allow first sentence of docstring to wrap to multiple lines.

* Fix  D417 Missing argument description in the docstring

* Update indent in pyproject.toml file
This commit is contained in:
Wei Ji
2025-12-09 21:22:01 +13:00
committed by GitHub
parent 5782d890d6
commit e3373026d6
17 changed files with 104 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pyproject.toml
+14
View File
@@ -59,8 +59,22 @@ asyncio_mode = "auto"
[tool.ruff.lint]
select = [
"COM", # flake8-commas
"D", # pydocstyle
"F", # pyflakes
"I", # isort
"RUF", # ruff-specific
"UP", # pyupgrade
]
extend-select = [
"D213", # Summary lines should be positioned on the second physical line of the docstring.
"D410", # A blank line after section headings.
]
ignore = [
"D205", # 1 blank line required between summary line and description
"D212", # Multi-line docstring summary should start at the first line
]
[tool.ruff.lint.pydocstyle]
# See https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
# for the enabled/disabled rules for the "google" convention.
convention = "google"