Add deprecation warning for validate paths argument #2024
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
In #1911, the
validate(paths=...)
argument was removed in favor of usingvalidate(path=...)
to simplify code and because validating multiple paths is a rarer use case that can be implemented by the user in a loop if needed.To follow the typical deprecation cycle and provide a warning to users using this keyword argument, this PR readds the
paths
argument and issues a deprecation warning for PyNWB 4.0.How to test the behavior?
Checklist
ruff check . && codespell
from the source directory.