Rename API function Session.open_virtual_file to Session.open_virtualfile (remove in v0.15.0) #2996
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
…(will be removed in v0.15.0)
seisman
added
deprecation
7 tasks
seisman
changed the title
seisman
changed the title
weiji14
approved these changes
Jan 17, 2024
pygmt/clib/session.py
Outdated
Comment on lines
1200
to
1201
| Examples | ||
| -------- |
There was a problem hiding this comment.
Is a doctest actually needed for the old open_virtual_file method? Or can we just omit it?
There was a problem hiding this comment.
Just want to make sure that the old function name still works as expected. But I'm OK with removing it, since it's a very simple wrapper.
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
The GMT API function name is
GMT_Open_VirtualFile, so the Python wrapper should beopen_virtualfilerather thanopen_virtual_file. We also usevirtualfile_from_vectors/matrix/gridrather thanvirtual_file_from_vectors/matrix/grid.The API function
Session.open_virtual_filehas been renamed toSession.open_virtualfilein a backward-compatible way and will be fully removed in v0.15.0 (four minor releases which is about one year). A warning will be raised if anyone uses the old function name.xref: https://docs.generic-mapping-tools.org/dev/devdocs/api.html#list-of-api-functions