Skip to content

Commit

Permalink
Add type hints for registrations
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Dec 12, 2023
1 parent ae21624 commit 8cce0b1
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions pygmt/datasets/mars_relief.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
The grids are available in various resolutions.
"""
from typing import Literal

from pygmt.datasets.load_remote_dataset import _load_remote_dataset
from pygmt.helpers import kwargs_to_strings

__doctest_skip__ = ["load_mars_relief"]


@kwargs_to_strings(region="sequence")
def load_mars_relief(resolution="01d", region=None, registration=None):
def load_mars_relief(
resolution="01d",
region=None,
registration: Literal["gridline", "pixel", None] = None,
):
r"""
Load the Mars relief dataset in various resolutions.
Expand Down Expand Up @@ -58,8 +64,9 @@ def load_mars_relief(resolution="01d", region=None, registration=None):
(i.e., ``"05m"``).
registration : str
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``"gridline"`` for
all resolutions except for ``"12s"`` which is ``"pixel"`` only.
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for all resolutions except for ``"12s"`` which is
``"pixel"`` only.
Returns
-------
Expand Down

0 comments on commit 8cce0b1

Please sign in to comment.