Add type hints for GMT anchor codes #3459
Merged
Conversation
This file contains 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
weiji14
approved these changes
Oct 11, 2024
| @@ -90,7 +93,7 @@ def text_( # noqa: PLR0912 | |||
| x/y : float or 1-D arrays | |||
| The x and y coordinates, or an array of x and y coordinates to plot | |||
| the text. | |||
| position : str | |||
| position | |||
There was a problem hiding this comment.
Small nit, could you reverse the order of L102 and L103 below, so that Vertical (TMD) is on top of Horizontal (LCR)?
seisman
added
maintenance
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of proposed changes
This PR adds typing hints for the GMT anchor codes like TL/TR.
The new module
pygmt._typingis inspired by https://github.com/numpy/numpy/tree/main/numpy/_typing and https://github.com/pandas-dev/pandas/blob/main/pandas/_typing.py.In GMT, the order of horizontal and vertical alignments doesn't matter, so both TL and LT are accepted, but here only codes like TL are added to avoid making the function signature to long.