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

Make docs stricter on variable naming #162

Open
BSchilperoort opened this issue Nov 13, 2024 · 1 comment
Open

Make docs stricter on variable naming #162

BSchilperoort opened this issue Nov 13, 2024 · 1 comment

Comments

@BSchilperoort
Copy link

currently the docs mostly state the following on naming:

The names are preferably in the form of CSDMS Standard Names.

However, this is a "preference". In some systems using BMI (for example remotebmi) things will completely break if users use characters which are not URL safe.

I would prefer it if the wording on (variable) naming was stronger; for example limiting it to alpha-numeric characters and underscores (A-z, 0-9, and _ ).

@PhilMiller
Copy link
Member

It might be preferable, but regardless, I think remotebmi and the like probably needs to escape any strings coming from model code, rather than passing them through verbatim.

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

2 participants