qref icon indicating copy to clipboard operation
qref copied to clipboard

Rename params & variables

Open mstechly opened this issue 1 year ago • 1 comments

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 avatar Aug 26 '24 16:08 mstechly

(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?

sammorley-short avatar Aug 27 '24 12:08 sammorley-short