Merge pull request #411 from dstansby/parse-url-docs

Document input/output for parse_url
ome · Dec 10, 2024 · 48d2813 · 48d2813
2 parents ec7f2ad + 831fab9
commit 48d2813
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Unreleased
 
 - Drop support for Python 3.8.
+- Document parameters and return value of `parse_url`.
 
 # 0.9.0 (May 2024)
 

diff --git a/ome_zarr/io.py b/ome_zarr/io.py
@@ -211,6 +211,14 @@ def parse_url(
 ) -> Optional[ZarrLocation]:
     """Convert a path string or URL to a ZarrLocation subclass.
 
+    :param path: Path to parse.
+    :param mode: Mode to open in.
+    :param fmt: Version of the OME-NGFF spec to open path with.
+
+    :return: `ZarrLocation`.
+        If mode is 'r', and the path does not exist returns None.
+        If there is an error opening the path, also returns None.
+
     >>> parse_url('does-not-exist')
     """
     try: