Conversation
weiji14
reviewed
Nov 2, 2025
| ] = "number", | ||
| quantile_value: float = 50, | ||
| region: Sequence[float | str] | str | None = None, | ||
| registration: Literal["gridline", "pixel"] | bool = False, |
Member
There was a problem hiding this comment.
Docstring for registration should be updated to 1) add bool type hint, and 2) indicate that registration=True means pixel registration.
pygmt/pygmt/helpers/decorators.py
Lines 279 to 283 in 25f2656
Member
Author
There was a problem hiding this comment.
add bool type hint,
Type hints are now added via function signatures, not in docstrings.
michaelgrund
approved these changes
Nov 5, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GMT documentation: https://docs.generic-mapping-tools.org/6.6/gmt.html#nodereg-full
The GMT CLI syntax is
-r[g|p]. Here, we use the descriptive values "gridline" and "pixel".I'm still thinking if we should support the
GridRegistrationenums (https://www.pygmt.org/dev/api/generated/pygmt.enums.GridRegistration.html#pygmt.enums.GridRegistration), i.e.,@GenericMappingTools/pygmt-maintainers What do you think?