Skip to content
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

consider making keyword-only parameters for some animations #111

Open
tlyu opened this issue Jan 25, 2023 · 2 comments
Open

consider making keyword-only parameters for some animations #111

tlyu opened this issue Jan 25, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@tlyu
Copy link
Contributor

tlyu commented Jan 25, 2023

Recent issues like #108, which seem to be the result of API changes in a base class, might be mitigated if the less-used parameters for animation classes like Comet were declared as keyword-only.

@tlyu
Copy link
Contributor Author

tlyu commented Jan 25, 2023

This is admittedly a breaking API change for anyone depending on supplying positional arguments for parameters that have defaults. Most (all?) of the examples seem to use keyword arguments for everything except the pixels object. Arguably, the API has already recently been broken in this way with the addition of the background_color parameter to Comet.

@tekktrik
Copy link
Member

I think this is a good change, but needs to be weighed against what would change in terms of existing Learn guides and other documentation. @kattni, tagging you about this as a heads up, happy to talk about what that would entail.

@tekktrik tekktrik added the enhancement New feature or request label Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants