Skip to content

Commit ae47287

Browse files
seismanweiji14
authored and
Josh Sixsmith
committed
List deprecated load_* functions in a separate table (GenericMappingTools#2228)
Co-authored-by: Wei Ji <[email protected]>
1 parent 6f29de0 commit ae47287

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/api/index.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,9 @@ Miscellaneous
213213
Datasets
214214
--------
215215

216-
PyGMT provides access to GMT's datasets through the :mod:`pygmt.datasets` package.
216+
PyGMT provides access to GMT's datasets through the :mod:`pygmt.datasets` module.
217217
These functions will download the datasets automatically the first time they are used
218-
and store them in the GMT cache folder.
218+
and store them in GMT's user data directory.
219219

220220
.. autosummary::
221221
:toctree: generated
@@ -224,6 +224,13 @@ and store them in the GMT cache folder.
224224
datasets.load_earth_age
225225
datasets.load_earth_relief
226226
datasets.load_sample_data
227+
228+
The following functions are deprecated since v0.6.0 and will be removed in v0.9.0.
229+
Use :func:`pygmt.datasets.load_sample_data` instead.
230+
231+
.. autosummary::
232+
:toctree: generated
233+
227234
datasets.load_fractures_compilation
228235
datasets.load_hotspots
229236
datasets.load_japan_quakes

0 commit comments

Comments
 (0)