Skip to content

Commit 729691c

Browse files
committed
Adding docs about cleanup_saved_downloads
1 parent 8737c90 commit 729691c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/testing.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,13 @@ This file only needs the ``get_package_data()`` function, which will tell
101101
paths_test = [os.path.join('data', '*.xml')]
102102
103103
return {'astroquery.module.tests': paths_test}
104+
105+
106+
Doctesting
107+
----------
108+
109+
Narrative documentation should also be tested, the ``doctest-remote-data`` directive provides a way
110+
to mark code snippets that relies on remote data access.
111+
112+
If any of the examples include saving data files locally, use the ``testcleanup`` directive and the
113+
`~astroquery.utils.cleanup_downloads.cleanup_saved_downloads` function at the end of the narrative documentation.

0 commit comments

Comments
 (0)