List deprecated load_* functions in a separate table (#2228)

Co-authored-by: Wei Ji <[email protected]>
GenericMappingTools · Dec 7, 2022 · f2924ea · f2924ea
1 parent 48375fe
commit f2924ea
Showing 1 changed file with 9 additions and 2 deletions.
diff --git 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 cache folder.
+and store them in 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