Skip to content

pygmt.datasets.load_*: Add autocompletion support for the 'resolution' parameter #3260

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 4 commits into from
May 25, 2024
Merged

pygmt.datasets.load_*: Add autocompletion support for the 'resolution' parameter #3260

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b3c5fc
Datasets: Add type hints for the resolution parameter
seisman May 19, 2024
9625b75
Update more functions
seisman May 23, 2024
e82bbaf
Merge branch 'main' into typing/resolution
seisman May 23, 2024
88a7dd3
Update pygmt/datasets/earth_magnetic_anomaly.py
seisman May 24, 2024
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
27 changes: 20 additions & 7 deletions pygmt/datasets/earth_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,23 @@

@kwargs_to_strings(region="sequence")
def load_earth_relief(
resolution="01d",
resolution: Literal[
"01d",
"30m",
"20m",
"15m",
"10m",
"06m",
"05m",
"04m",
"03m",
"02m",
"01m",
"30s",
"15s",
"03s",
"01s",
] = "01d",
region=None,
registration: Literal["gridline", "pixel", None] = None,
data_source: Literal["igpp", "gebco", "gebcosi", "synbath"] = "igpp",
Expand Down Expand Up @@ -58,12 +74,9 @@ def load_earth_relief(

Parameters
----------
resolution : str
The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for
arc-degrees, arc-minutes, and arc-seconds. It can be ``"01d"``,
``"30m"``, ``"20m"``, ``"15m"``, ``"10m"``, ``"06m"``, ``"05m"``,
``"04m"``, ``"03m"``, ``"02m"``, ``"01m"``, ``"30s"``, ``"15s"``,
``"03s"``, or ``"01s"``.
resolution
The grid resolution. The suffix ``d``, ``m`` and ``s`` stand for arc-degrees,
arc-minutes, and arc-seconds.

region : str or list
The subregion of the grid to load, in the form of a list
Expand Down