diff --git a/doc/api/index.rst b/doc/api/index.rst index f85df5d..240cd49 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -27,7 +27,7 @@ Functions: .. autosummary:: :toctree: generated/ - ensaio.v1.cache_folder + ensaio.v1.locate ensaio.v1.fetch_alps_gps ensaio.v1.fetch_britain_magnetic ensaio.v1.fetch_british_columbia_lidar diff --git a/doc/tutorial_src/using.py b/doc/tutorial_src/using.py index 61bd2c3..898d9ab 100644 --- a/doc/tutorial_src/using.py +++ b/doc/tutorial_src/using.py @@ -68,8 +68,8 @@ # ------------------- # # The location of the cache folder varies by operating system. Use the -# :func:`ensaio.v1.cache_folder` function to get its location on your computer. -print(ensaio.cache_folder()) +# :func:`ensaio.v1.locate` function to get its location on your computer. +print(ensaio.locate()) ############################################################################### # You can also set the location manually by creating a ``ENSAIO_V1_DATA_DIR`` diff --git a/ensaio/tests/test_v1.py b/ensaio/tests/test_v1.py index d982c88..0605843 100644 --- a/ensaio/tests/test_v1.py +++ b/ensaio/tests/test_v1.py @@ -27,8 +27,8 @@ def test_v1_fetch_datasets(fetch): assert path.exists() -def test_v1_cache_folder(): +def test_v1_locate(): "Check that the cache folder exists by default after a fetch call" FETCH_FUNCTIONS[0]() - path = v1.cache_folder() + path = v1.locate() assert path.exists() diff --git a/ensaio/v1.py b/ensaio/v1.py index 73a5d46..cbb0e9c 100644 --- a/ensaio/v1.py +++ b/ensaio/v1.py @@ -53,9 +53,9 @@ def _repository(): return repository -def cache_folder(): +def locate(): """ - The location of the data cache for v1 datasets + Return the location of the system-dependent data cache for v1 datasets This folder is not guaranteed to exist in the file system until a dataset has been downloaded. @@ -66,7 +66,7 @@ def cache_folder(): Returns ------- - cache : :class:`pathlib.Path` + path : :class:`pathlib.Path` Path to the cache folder. """ return _repository().abspath