clib.Session.create_data: Improve docstrings and fix the comments for the dim parameter
#3532
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
seisman
added
documentation
seisman
force-pushed
the
typing/create_data
branch
from
f50b700
to
810d94e
Compare
… the `dim` parameter
seisman
force-pushed
the
typing/create_data
branch
from
810d94e
to
77651eb
Compare
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
seisman
added
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.
This PR focuses on improving the docstrings, especially for the different meanings of the
dimparameter for different GMT data containers.The failures in "Static Type Checks" may need to wait for changes in #3530.Preview: https://pygmt-dev--3532.org.readthedocs.build/en/3532/api/generated/pygmt.clib.Session.create_data.html