Skip to content

Comments

Remove deprecated path argument#88

Merged
aazuspan merged 1 commit intomainfrom
remove-deprecated-path-arg
Aug 23, 2025
Merged

Remove deprecated path argument#88
aazuspan merged 1 commit intomainfrom
remove-deprecated-path-arg

Conversation

@aazuspan
Copy link
Owner

Using path was a shortcut for writing directly to NetCDF that's been deprecated for almost two years. Users can call the to_netcdf method of the returned object instead.

Since path was the first positional argument, removing it will change the order of the remaining to_xarray arguments, so I'm changing them all to keyword-only at the same time. This will be a breaking change for anyone who was calling the method with positional arguments, but I suspect that this is a rare use case since you would need to explicitly pass None as the first argument to avoid the deprecation warning.

This was a shortcut for writing directly to NetCDF that's been
deprecated for almost two years. Since removing it will shift the
order of positional arguments, I went ahead and made the arguments
keyword-only at the same time. I suspect that's how the vast
majority of users were calling it anyways, since the first argument
was the deprecated "path".
@aazuspan aazuspan self-assigned this Aug 23, 2025
@aazuspan aazuspan merged commit 1385233 into main Aug 23, 2025
7 checks passed
@aazuspan aazuspan deleted the remove-deprecated-path-arg branch August 23, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant