bmi icon indicating copy to clipboard operation
bmi copied to clipboard

Make docs stricter on variable naming

Open BSchilperoort opened this issue 1 year ago • 1 comments

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 _ ).

BSchilperoort avatar Nov 13 '24 09:11 BSchilperoort

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.

PhilMiller avatar Nov 13 '24 18:11 PhilMiller