GMTDataArrayAccessor: Improve the documentation to clarify how the accessor works #3955
Conversation
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
seisman
added
documentation
seisman
changed the title
michaelgrund
approved these changes
May 22, 2025
seisman
added
final review call
weiji14
reviewed
May 24, 2025
Comment on lines
+35
to
+37
| :class:`xarray.DataArray` instance. Thus, the *gmt* accessor will be re-initialized | ||
| in cases where the :class:`xarray.DataArray` is manipulated (e.g., arithmetic and | ||
| slice operations) or when accessing a :class:`xarray.DataArray` from a |
There was a problem hiding this comment.
"Slice"-ing is still mentioned here?
There was a problem hiding this comment.
Yes, slice operation creates a new xarray.DataArray instance, so the gmt accessor is re-initialized. The registration and gtype information are correct if the source encoding exists (e.g., loaded via xr.load_dataarray) or incorrect if the source encoding is None (e.g., xr.DataArray created from scracth).
seisman
commented
May 26, 2025
| plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed | ||
| explanations and workarounds. | ||
| :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to | ||
| :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations. |
There was a problem hiding this comment.
I've also simplified the notes in the load_xxx functions. Please review it and then I'll apply the changes to other load_xxx functions after approval.
Edit: I've updated all files.
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.
Closes #524.
Preview: