DEPR: deprecate calling yt.load with first argument passed as keyword #4177
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.
PR Summary
This is a proposed solution to close #2879:
IMO, the name of the first argument to yt.load is bound to be meaningless.
It's current name
fn
is short for "filename", but we support loading from directories and in some cases, urls !I think that making it a positional-only argument lifts out the weigh of carying a meaningless name forever.
Now, the difficult part is in continuously evolving the API to avoid sudden breaking changes, which is why 99% of this patch consists in adding a custom decorator to do just that, so existing code that might rely on loading data as
yt.load(fn=..., ...)
will not immediately break but will still emit some warnings, and we can keep backward compatibility for a while.TODO: