docs: Update docstring for platform specific return class

datasciencecampus · Sep 19, 2023 · 902061e · 902061e
1 parent 789870e
commit 902061e
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/transport_performance/utils/defence.py b/src/transport_performance/utils/defence.py
@@ -9,7 +9,7 @@
 
 def _handle_path_like(
     pth: Union[str, pathlib.Path, pathlib.PosixPath], param_nm: str
-) -> pathlib.PosixPath:
+) -> pathlib.Path:
     """Handle path-like parameter values.
 
     Checks a path for symlinks and relative paths. Converts to realpath &
@@ -30,7 +30,9 @@ def _handle_path_like(
     Returns
     -------
     pathlib.Path
-        Platform agnostic representation of pth.
+        Platform agnostic representation of pth. On unix-like a PosixPath is
+        returned. On windows a WindowsPath is returned. Both are children of
+        pathlib.Path.
 
     """
     if not isinstance(pth, (str, pathlib.Path, pathlib.PosixPath)):