Skip to content

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

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 4, 2024

Related to #3836.

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

@seisman seisman force-pushed the refactor/virtualfile_in branch 2 times, most recently from f1e6aca to 9e78da0 Compare August 4, 2024 11:01
@seisman seisman changed the title Session.virtualfile_in: Remove the extra_arrays parameter Refactor Session.virtualfile_in, removing 'extra_arrays'/'required_z' and add 'required_cols' Aug 4, 2024
@seisman seisman force-pushed the refactor/virtualfile_in branch 2 times, most recently from 2a1db22 to b33476c Compare August 4, 2024 12:39
@seisman seisman added this to the 0.14.0 milestone Aug 5, 2024
@seisman seisman removed this from the 0.14.0 milestone Sep 5, 2024
@seisman seisman force-pushed the refactor/data_kind branch from bca59f5 to 808755d Compare October 3, 2024 09:21
@seisman seisman changed the base branch from refactor/data_kind to main October 3, 2024 09:26
@seisman seisman self-assigned this Oct 30, 2024
@seisman seisman 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 seisman force-pushed the refactor/virtualfile_in branch from d7ca533 to feddd9c Compare March 5, 2025 08:06
@@ -115,6 +115,7 @@ def _validate_data_input(
GMTInvalidInput
If the data input is not valid.
"""
required_z = ncols >= 3
Copy link
Member Author

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.

@seisman seisman added the deprecation Deprecating a feature label Mar 10, 2025
@seisman seisman 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
@seisman seisman 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
@seisman seisman added the needs review This PR has higher priority and needs review. label Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature needs review This PR has higher priority and needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant