document check_compatibility_ilastik_impl

bioimage-io · Nov 12, 2024 · c6ac120 · c6ac120
1 parent 09a0787
commit c6ac120
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/scripts/check_compatibility_ilastik.py b/scripts/check_compatibility_ilastik.py
@@ -26,7 +26,14 @@ def check_compatibility_ilastik_impl(
     rdf_url: str,
     sha256: str,
     report_path: Path,
-):
+) -> None:
+    """Write `CompatibilityReport` for a resource description.
+
+    Args:
+        rdf_url: URL to the rdf.yaml file
+        sha256: SHA-256 value of **rdf_url** content
+        report_path: path to save `CompatibilityReport` as json to
+    """
     report_path.parent.mkdir(parents=True, exist_ok=True)
 
     rdf = download_rdf(rdf_url, sha256)