Skip to content

clib: Rename the virtualfile_from_data method to virtualfile_in - #3068

Merged
seisman merged 5 commits into
mainfrom
virtualfile_in
Mar 1, 2024
Merged

clib: Rename the virtualfile_from_data method to virtualfile_in#3068
seisman merged 5 commits into
mainfrom
virtualfile_in

Conversation

@seisman

@seismanseisman commented Feb 26, 2024

Copy link
Copy Markdown
Member

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

Address #3057 (comment)

@seismanseisman mentioned this pull request Feb 26, 2024
Merged
7 tasks
@seismanseisman added deprecation Deprecating a feature needs review This PR has higher priority and needs review. labels Feb 26, 2024
@seismanseisman added this to the 0.12.0 milestone Feb 26, 2024
@seismanseisman changed the title Rename API function virtualfile_from_data to virtualfile_inclib.session: Rename the virtualfile_from_data method to virtualfile_inFeb 26, 2024
@seismanseisman changed the title clib.session: Rename the virtualfile_from_data method to virtualfile_inclib: Rename the virtualfile_from_data method to virtualfile_inFeb 27, 2024
@seismanseisman 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
@seismanseisman 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 mainMar 1, 2024
@seisman
seisman deleted the virtualfile_in branch March 1, 2024 02:14
@seismanseisman mentioned this pull request Mar 11, 2024
Merged
weiji14
weiji14 reviewed May 2, 2024
View reviewed changes
Comment threadpygmt/clib/session.py
Comment on lines +1612 to +1613
# virtualfile_from_data was renamed to virtualfile_in since v0.12.0.
virtualfile_from_data = virtualfile_in

@weiji14weiji14May 2, 2024

Copy link
Copy Markdown
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?

@seismanseismanMay 2, 2024

Copy link
Copy Markdown
MemberAuthor

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

@yvonnefroehlichyvonnefroehlichMay 2, 2024•
edited
Loading

Copy link
Copy Markdown
Member

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.

@seismanseisman mentioned this pull request May 5, 2024
Merged
@seismanseisman mentioned this pull request Aug 4, 2024
Closed
39 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weiji14weiji14weiji14 left review comments
@yvonnefroehlichyvonnefroehlichyvonnefroehlich left review comments

Assignees

No one assigned

Labels

deprecationDeprecating a feature

Projects

None yet

Milestone

0.12.0

Development

Successfully merging this pull request may close these issues.

3 participants

@seisman@weiji14@yvonnefroehlich