Improve the docstrings for the GMT_Open_VirtualFile wrapper #2408
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
maintenance
seisman
force-pushed
the
improve-open-virtualfile
branch
from
2befba7 to
dbc518b
Compare
seisman
commented
Mar 9, 2023
| ) | ||
| from pygmt.helpers import data_kind, dummy_context, fmt_docstring, tempfile_from_geojson | ||
|
|
||
| FAMILIES = [ |
There was a problem hiding this comment.
Added GMT_IS_IMAGE, GMT_IS_POSTSCRIPT and GMT_IS_CUBE although they're not used now, but they will be used in the future.
| "GMT_IS_POLYGON", | ||
| "GMT_IS_PLP", | ||
| "GMT_IS_SURFACE", | ||
| "GMT_IS_NONE", # items without geometry (e.g., CPT) |
There was a problem hiding this comment.
Added GMT_IS_LP and GMT_IS_VOLUME which were missing.
| The ctypes void pointer to your GMT data structure. | ||
| ``"GMT_IS_REFERENCE"`` to tell GMT the data are read-only, or | ||
| ``"GMT_IS_DUPLICATE"`` to tell GMT to duplicate the data. | ||
| data : int or None |
There was a problem hiding this comment.
michaelgrund
approved these changes
Mar 9, 2023
Co-authored-by: Michael Grund <[email protected]>
seisman
added
the
final review call
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
Almost no code changes. Just add more comments and docstrings to make the code easier to understand.
References:
Fixes #
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