From 63fd194d3895999e46b0e55434699a9f7dbdcbab Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 6 Dec 2022 15:20:25 +0800 Subject: [PATCH 1/2] List deprecated load_* functions in a separate table --- doc/api/index.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/api/index.rst b/doc/api/index.rst index 40f6fc8fad4..a2fb76918f9 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -215,7 +215,7 @@ Datasets PyGMT provides access to GMT's datasets through the :mod:`pygmt.datasets` package. These functions will download the datasets automatically the first time they are used -and store them in the GMT cache folder. +and store them in the GMT's user data directory. .. autosummary:: :toctree: generated @@ -224,6 +224,13 @@ and store them in the GMT cache folder. datasets.load_earth_age datasets.load_earth_relief datasets.load_sample_data + +The following functions are deprecated since v0.6.0 and will be removed in v0.9.0. +Use :func:`pygmt.datasets.load_sample_data` instead. + +.. autosummary:: + :toctree: generated + datasets.load_fractures_compilation datasets.load_hotspots datasets.load_japan_quakes From 31c0e0c4113f3836fb9c09baf52a2c1c8eb6ca9f Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 7 Dec 2022 08:00:54 +0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- doc/api/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/index.rst b/doc/api/index.rst index a2fb76918f9..035f1df87d9 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -213,9 +213,9 @@ Miscellaneous Datasets -------- -PyGMT provides access to GMT's datasets through the :mod:`pygmt.datasets` package. +PyGMT provides access to GMT's datasets through the :mod:`pygmt.datasets` module. These functions will download the datasets automatically the first time they are used -and store them in the GMT's user data directory. +and store them in GMT's user data directory. .. autosummary:: :toctree: generated