Skip to content
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

load_earth_relief: Add earth_relief_type explanation to docstrings #2231

Merged
merged 3 commits into from
Dec 7, 2022
Merged

load_earth_relief: Add earth_relief_type explanation to docstrings #2231

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cb86ba
Add earth_relief_type explanation to load_earth_relief docstring
willschlitzer Dec 6, 2022
004747e
Apply suggestions from code review
willschlitzer Dec 6, 2022
de168b0
Merge branch 'main' into explain-earth-relief-type
willschlitzer Dec 6, 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
8 changes: 5 additions & 3 deletions pygmt/datasets/earth_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ def load_earth_relief(

This module downloads the grids that can also be accessed by
passing in the file name **@**\ *earth_relief_type*\_\ *res*\[_\ *reg*] to
any grid plotting/processing function. *res* is the grid resolution
(see below), and *reg* is grid registration type (**p** for pixel
registration or **g** for gridline registration).
any grid plotting/processing function. *earth_relief_type* is the GMT name
for the dataset. The available options are **earth_relief**\,
**earth_gebco**\, **earth_gebcosi**\, and **earth_synbath**\. *res* is the
grid resolution (see below), and *reg* is grid registration type
(**p** for pixel registration or **g** for gridline registration).

Refer to :gmt-datasets:`earth-relief.html` for more details about available
datasets, including version information and references.
Expand Down