Document limitations of GMT xarray accessors #2375
Merged
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
force-pushed
the
accessor-limitations
branch
from
7437520 to
9104524
Compare
seisman
force-pushed
the
accessor-limitations
branch
from
9104524 to
628648a
Compare
seisman
changed the title
Member
Author
|
Ping @GenericMappingTools/pygmt-maintainers for reviews. |
weiji14
approved these changes
Feb 22, 2023
Member
weiji14
left a comment
weiji14
left a comment
There was a problem hiding this comment.
Just one very minor suggestion, but otherwise I think it's documented really well!
Comment on lines
+85
to
+90
| Inplace assignment operators like ``*=`` don't create new instances, so the | ||
| properties are still kept: | ||
| >>> grid *= 2.0 | ||
| >>> grid.gmt.registration, grid.gmt.gtype | ||
| (0, 1) |
Member
There was a problem hiding this comment.
Interesting, good to know that in-place assignment preserves the registration and gtype information!
Comment on lines
+16
to
+17
| The accessor extends :class:`xarray.DataArray` to store GMT-specific | ||
| properties about grids, which are important for PyGMT to correctly process |
Member
There was a problem hiding this comment.
Technically xarray accessors are not just about setting properties/attributes. You may need to change this sentence if the .gmt.imshow() function at #2372 is added to this accessor class.
weiji14
added
final review call
Co-authored-by: Yvonne Fröhlich <[email protected]> Co-authored-by: Wei Ji <[email protected]>
michaelgrund
approved these changes
Feb 22, 2023
seisman
removed
the
final review call
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
See #499 for context.
Preview: https://pygmt-dev--2375.org.readthedocs.build/en/2375/api/generated/pygmt.GMTDataArrayAccessor.html
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version