Rename params & variables - Githubissues

PsiQ / qref

Quantum Resource Estimate Format

https://psiq.github.io/qref/

Apache License 2.0

34 stars 3 forks source link

Rename params & variables #115

Open mstechly opened 2 months ago

mstechly commented 2 months ago

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.

sammorley-short commented 2 months ago

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