Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clib: Rename the virtualfile_from_data method to virtualfile_in #3068

Merged
merged 5 commits into from
Mar 1, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 26, 2024

Rename virtualfile_from_data to virtualfile_in. The old name is still supported but will be removed in the future.

Address #3057 (comment)

@seisman seisman added deprecation Deprecating a feature needs review This PR has higher priority and needs review. labels Feb 26, 2024
@seisman seisman added this to the 0.12.0 milestone Feb 26, 2024
@seisman seisman changed the title Rename API function virtualfile_from_data to virtualfile_in clib.session: Rename the virtualfile_from_data method to virtualfile_in Feb 26, 2024
@seisman seisman changed the title clib.session: Rename the virtualfile_from_data method to virtualfile_in clib: Rename the virtualfile_from_data method to virtualfile_in Feb 27, 2024
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Feb 29, 2024
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 1, 2024
@seisman seisman merged commit e8dc8d4 into main Mar 1, 2024
17 of 19 checks passed
@seisman seisman deleted the virtualfile_in branch March 1, 2024 02:14
Comment on lines +1612 to +1613
# virtualfile_from_data was renamed to virtualfile_in since v0.12.0.
virtualfile_from_data = virtualfile_in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Originally posted by @yvonnefroehlich in #3180 (comment)

Regarding the point

* clib: Rename the "virtualfile_from_data" method to "virtualfile_in" ([#3068](https://github.com/GenericMappingTools/pygmt/pull/3068))

I was / am a bit unsure, as there ins no FutureWarning added and not version stated when virtualfile_from_data is removed.

@seisman, did you want to keep this virtualfile_from_data alias around, or remove it at some point? If removing, should we start to raise a FutureWarning in v0.13.0, and remove it completely in v0.15.0?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If removing, should we start to raise a FutureWarning in v0.13.0, and remove it completely in v0.15.0?

Sounds good

Copy link
Member

@yvonnefroehlich yvonnefroehlich May 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also fine with me.

I have added this to the changelog for v0.12.0; feel free to remove it if you think it is better not to state it before we have implemented it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants