Merge pull request #171 from mwcraig/fix-filename-type

Better document type options
astropy · Jul 10, 2023 · 50258f2 · 50258f2
2 parents c0ec34a + 0e37459
commit 50258f2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/astrowidgets/ginga.py b/astrowidgets/ginga.py
@@ -980,7 +980,7 @@ def save(self, filename, overwrite=False):
 
         Parameters
         ----------
-        filename : str
+        filename : str or `os.PathLike`
             Name of file to save to.
 
         overwrite : bool, optional

diff --git a/astrowidgets/interface_definition.py b/astrowidgets/interface_definition.py
@@ -96,7 +96,7 @@ def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
 
         Parameters
         ----------
-        filename : str
+        filename : str or `os.PathLike`
             The file to save to. The format is determined by the
             extension.