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
tests/tools/test_naip.py
+2 -2
View File
@@ -1,3 +1,5 @@
"""Tests for NAIP tool."""
from types import NoneType
import pytest
@@ -19,7 +21,6 @@ async def test_fetch_naip():
- Internet access (to reach Planetary Computer STAC + blobs)
- Planetary Computer / NAIP service to be up
"""
# Union Market coordinates from GeoNames: 38.90789, -76.99831
# N 38°54'28" W 76°59'54"
# We'll use a small neighborhood AOI around that point.
@@ -60,7 +61,6 @@ async def test_fetch_naip_too_large():
- Internet access (to reach Planetary Computer STAC + blobs)
- Planetary Computer / NAIP service to be up
"""
# Union Market coordinates from GeoNames: 38.90789, -76.99831
# N 38°54'28" W 76°59'54"
# We'll use a small neighborhood AOI around that point.