Skip to content

Session.virtualfile_in: Deprecate parameter 'required_z'. Use 'mincols' instead (will be removed in v0.20.0) - #3369

Merged
seisman merged 20 commits into
mainfrom
refactor/virtualfile_in
Apr 28, 2025
Merged

Session.virtualfile_in: Deprecate parameter 'required_z'. Use 'mincols' instead (will be removed in v0.20.0)#3369
seisman merged 20 commits into
mainfrom
refactor/virtualfile_in

Conversation

@seisman

@seismanseisman commented Aug 4, 2024

Copy link
Copy Markdown
Member

Related to #3836.

This PR removes the required_z parameter and add a new parameter mincols. required_z=True means mincols=3.

@seisman
seismanforce-pushed the refactor/virtualfile_in branch 2 times, most recently from f1e6aca to 9e78da0CompareAugust 4, 2024 11:01
@seismanseisman changed the title Session.virtualfile_in: Remove the extra_arrays parameterRefactor Session.virtualfile_in, removing 'extra_arrays'/'required_z' and add 'required_cols'Aug 4, 2024
@seisman
seismanforce-pushed the refactor/virtualfile_in branch 2 times, most recently from 2a1db22 to b33476cCompareAugust 4, 2024 12:39
@seismanseisman added this to the 0.14.0 milestone Aug 5, 2024
@seismanseisman removed this from the 0.14.0 milestone Sep 5, 2024
@seisman
seisman changed the base branch from refactor/data_kind to mainOctober 3, 2024 09:26
@seismanseisman self-assigned this Oct 30, 2024
@seismanseisman changed the title Refactor Session.virtualfile_in, removing 'extra_arrays'/'required_z' and add 'required_cols'Session.virtualfile_in: Remove parameter 'required_z' and add 'ncols'Mar 5, 2025
@seisman
seismanforce-pushed the refactor/virtualfile_in branch from d7ca533 to feddd9cCompareMarch 5, 2025 08:06
Comment threadpygmt/helpers/utils.py Outdated
GMTInvalidInput
If the data input is not valid.
"""
required_z = ncols >= 3

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.

This is just a temporary fix. Will refactor _validate_data_input in #3818.

@seismanseisman added the deprecation Deprecating a feature label Mar 10, 2025
@seismanseisman changed the title Session.virtualfile_in: Remove parameter 'required_z' and add 'ncols'Session.virtualfile_in: Deprecate parameter 'required_z'. Use 'ncols' instead (will be removed in v0.20.0)Mar 26, 2025
@seisman
seisman marked this pull request as ready for review March 26, 2025 09:19
@seismanseisman added needs review This PR has higher priority and needs review. and removed needs review This PR has higher priority and needs review. labels Mar 28, 2025
@seisman
seisman marked this pull request as draft April 2, 2025 04:13
@seisman
seisman marked this pull request as ready for review April 15, 2025 02:53
@seismanseisman added the needs review This PR has higher priority and needs review. label Apr 15, 2025

@weiji14weiji14 left a comment

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.

Debating on whether to call the parameter mincols instead of ncols, but leave it up to you to decide.

Comment threadpygmt/clib/session.py Outdated
seismanand others added 3 commits April 28, 2025 15:57
@seismanseisman changed the title Session.virtualfile_in: Deprecate parameter 'required_z'. Use 'ncols' instead (will be removed in v0.20.0)Session.virtualfile_in: Deprecate parameter 'required_z'. Use 'mincols' instead (will be removed in v0.20.0)Apr 28, 2025
@seisman
seisman merged commit f389e05 into mainApr 28, 2025
@seisman
seisman deleted the refactor/virtualfile_in branch April 28, 2025 09:00
@seismanseisman removed the needs review This PR has higher priority and needs review. label Apr 28, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deprecationDeprecating a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman@weiji14