Skip to content

DOC: Typo fixes / formulation improvements #3729

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
merged 2 commits into from
Dec 29, 2024
Merged

DOC: Typo fixes / formulation improvements #3729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1e34bf
Improve formulation in docs for remote datasets
yvonnefroehlich Dec 28, 2024
d4a4b64
Merge branch 'main' into fix-typos-82
seisman Dec 29, 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
5 changes: 3 additions & 2 deletions pygmt/datasets/earth_free_air_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ def load_earth_free_air_anomaly(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None`` which means
``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"`` only.
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"``
only.
uncertainty
By default, the Earth free-air anomaly values are returned. Set to ``True`` to
return the related uncertainties instead.
Expand Down
6 changes: 3 additions & 3 deletions pygmt/datasets/earth_magnetic_anomaly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ def load_earth_magnetic_anomaly(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except ``"02m"`` for
``data_source="emag2"`` or ``data_source="emag2_4km"``, which are
``"pixel"`` only.
``data_source="emag2"`` or ``data_source="emag2_4km"``, which are ``"pixel"``
only.
data_source
Select the source of the magnetic anomaly data. Available options are:

Expand Down
6 changes: 3 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 @@ -83,9 +83,9 @@ def load_earth_relief(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for all resolutions except ``"15s"`` which is
``"pixel"`` only.
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except ``"15s"`` which is ``"pixel"``
only.
data_source
Select the source for the Earth relief data. Available options are:

Expand Down
6 changes: 3 additions & 3 deletions pygmt/datasets/earth_vertical_gravity_gradient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ def load_earth_vertical_gravity_gradient(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for all resolutions except ``"01m"`` which is
``"pixel"`` only.
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"``
only.

Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion pygmt/datasets/mars_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def load_mars_relief(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except for ``"12s"`` which is ``"pixel"``
only.

Expand Down
2 changes: 1 addition & 1 deletion pygmt/datasets/mercury_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def load_mercury_relief(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except for ``"56s"`` which is ``"pixel"``
only.

Expand Down
2 changes: 1 addition & 1 deletion pygmt/datasets/moon_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def load_moon_relief(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except for ``"14s"`` which is ``"pixel"``
only.

Expand Down
2 changes: 1 addition & 1 deletion pygmt/datasets/pluto_relief.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def load_pluto_relief(
higher than 5 arc-minutes (i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration. Default is ``None``, means
``"gridline"`` for gridline registration. Default is ``None``, which means
``"gridline"`` for all resolutions except for ``"52s"`` which is ``"pixel"``
only.

Expand Down
Loading