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

[release/v1] Rules for "flag", "index", and other similar control variables #101

Open
mkavulich opened this issue Mar 21, 2025 · 0 comments

Comments

@mkavulich
Copy link
Collaborator

We have vaguely discussed a plan for handling "flag" variables, which I've been treating as a category including all variables that are specific to model code or other logical controls rather than physical quantities. This can include a number of possible variable types, often (but not always) indicated by a prefix:

  1. Boolean indicators for whether a scheme, section of code, or other option is being exercised, or condition is met. Prefixes include flag_for_, do_, is_
  2. Integer index of a particular list, table, or other data structure controlling code execution, file read/write, or other.... Prefixes include index_of_, control_for_, identifier_for_

The plan is to separate out all of these "control variables" into a dedicated section, with dedicated rules setting out their naming conventions, since these variables often do not fit neatly into the schema we have developed for naming physical quantities.

@mkavulich mkavulich changed the title Rules for "flag", "index", and other similar control variables [release/v1] Rules for "flag", "index", and other similar control variables Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant