Skip to content

List deprecated load_* functions in a separate table #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seisman merged 2 commits into from
Dec 7, 2022
Merged

List deprecated load_* functions in a separate table #2228

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63fd194
List deprecated load_* functions in a separate table
seisman Dec 6, 2022
31c0e0c
Apply suggestions from code review
seisman Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions doc/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down