dataforcanada/d4c-service-geo-assistant
1
0
Fork 0
mirror of https://github.com/dataforcanada/d4c-service-geo-assistant.git synced 2026-06-15 07:21: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_summarize.py
+4
View File
@@ -23,6 +23,10 @@ TEST_IMAGE_URL = "https://petapixel.com/assets/uploads/2022/08/French-Officials-
],
)
async def test_summarize_sat_img(img_url, summary):
"""
Ensure that the `summarize_sat_img` tool can describe a satellite image in JPEG
format.
"""
# Load the image from the supplied URL and encode it in base64
headers = {
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",