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

Rename params & variables #115

Open
mstechly opened this issue Aug 26, 2024 · 1 comment
Open

Rename params & variables #115

mstechly opened this issue Aug 26, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@mstechly
Copy link
Contributor

Currently schema has some fields with confusing names:

  • input_params
  • local_variables
  • linked_params

This naming is not very consistent, as "params" and "variables" are used interchangeably here. According to the distinction introduced here, it

It has been also slightly confusing when working on Qualtran integration.

It seems that better language would be renaming it in the following way:

  • input_params -> input_symbols
  • local_variables -> local_symbols
  • linked_params -> linked_symbols

Open to other suggestions though.

@mstechly mstechly added the enhancement New feature or request label Aug 26, 2024
@sammorley-short
Copy link

(FYI I think your post was incomplete: "According to the distinction introduced here, it...")

I don't think symbols is actually an improvement here, since it doesn't capture their functional significance to the problem being solved. But as for the inconsistent naming between parameters and variables, sure. So would be happy moving everything to "variables" if that is also an acceptable solution?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants