Making new cleanup_saved_downloads part of the public API

astropy · Apr 29, 2022 · fec0444 · fec0444
1 parent d910c7a
commit fec0444
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 6 deletions.
diff --git a/astroquery/utils/__init__.py b/astroquery/utils/__init__.py
@@ -11,3 +11,5 @@
 from .commons import *
 from .process_asyncs import async_to_sync
 from .docstr_chompers import prepend_docstr_nosections
+from .cleanup_downloads import cleanup_saved_downloads
+
diff --git a/astroquery/utils/cleanup_downloads.py b/astroquery/utils/cleanup_downloads.py
@@ -6,14 +6,16 @@
 import os
 import shutil
 
+__all__ = ['cleanup_saved_downloads']
+
 
 def cleanup_saved_downloads(names):
     """ Function to clean up save files.
 
     Parameters
     ----------
     names : str or list of str
-        Files or directories to clean up. Wildcards are excepted.
+        Files or directories to clean up. Wildcards are accepted.
     """
 
     if isinstance(names, str):

diff --git a/docs/cadc/cadc.rst b/docs/cadc/cadc.rst
@@ -661,5 +661,5 @@ Reference/API
 
 .. testcleanup::
 
-    >>> from astroquery.utils.cleanup_downloads import cleanup_saved_downloads
+    >>> from astroquery.utils import cleanup_saved_downloads
     >>> cleanup_saved_downloads(['my_observations.xml', 'test_output_noauth.xml'])
diff --git a/docs/esa/hsa/hsa.rst b/docs/esa/hsa/hsa.rst
@@ -244,5 +244,5 @@ Reference/API
 
 .. testcleanup::
 
-    >>> from astroquery.utils.cleanup_downloads import cleanup_saved_downloads
+    >>> from astroquery.utils import cleanup_saved_downloads
     >>> cleanup_saved_downloads(['1342195355*', 'results.csv'])
diff --git a/docs/ipac/irsa/sha/sha.rst b/docs/ipac/irsa/sha/sha.rst
@@ -103,5 +103,5 @@ Reference/API
 
 .. testcleanup::
 
-    >>> from astroquery.utils.cleanup_downloads import cleanup_saved_downloads
+    >>> from astroquery.utils import cleanup_saved_downloads
     >>> cleanup_saved_downloads(['sha_tmp'])
diff --git a/docs/mast/mast.rst b/docs/mast/mast.rst
@@ -1263,6 +1263,6 @@ Reference/API
 
 .. testcleanup::
 
-    >>> from astroquery.utils.cleanup_downloads import cleanup_saved_downloads
+    >>> from astroquery.utils import cleanup_saved_downloads
     >>> cleanup_saved_downloads(['mastDownload*', 'tess-*', 'lwp13058*', '3dhst*'])
 
diff --git a/docs/testing.rst b/docs/testing.rst
@@ -110,4 +110,4 @@ Narrative documentation should also be tested, the ``doctest-remote-data`` direc
 to mark code snippets that relies on remote data access.
 
 If any of the examples include saving data files locally, use the ``testcleanup`` directive and the
-`~astroquery.utils.cleanup_downloads.cleanup_saved_downloads` function at the end of the narrative documentation.
+`~astroquery.utils.cleanup_saved_downloads` function at the end of the narrative documentation.