Fix AuthClient.create_policy signature #925
Closed
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.
Fixing the signature is an inherently breaking change. Therefore, move to keyword-only arguments as a progressive upgrade which makes this easier to manage into the future.
Per our team discussion, although this is a violation of the semver backwards compatibility policy (and not in a marginal way, but very clearly we are breaking an API which we had previously declared), doing this does more good than harm.
The API is relatively newly released, and any fix here either has to encode these as optional positional args or else has to handle things in an awkward way.
Given the short lifetime to-date of the SDK version with this method available, we are making the decision that breaking the compatibility policy is better than strict adherence in this case.
📚 Documentation preview 📚: https://globus-sdk-python--925.org.readthedocs.build/en/925/