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

Standardize component constructor params/param_defaults/kwargs #2698

Open
kmantel opened this issue Jun 13, 2023 · 0 comments
Open

Standardize component constructor params/param_defaults/kwargs #2698

kmantel opened this issue Jun 13, 2023 · 0 comments

Comments

@kmantel
Copy link
Collaborator

kmantel commented Jun 13, 2023

Parameter values in component constructors can be given either as standard keyword arguments, or in dictionary form. For shell/base classes and Compositions, the argument for the dictionary form is param_defaults, and for most other components, it's params. I think we should decide to either use params or param_defaults globally or drop the extra dictionary specification and assume that using a **params syntax would be enough for that situation.

If we keep it, I think we should make sure that it's clear in the documentation that those values silently take priority over values passed as keyword arguments or add a warning if an override occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant