MetOffice / CSET

Toolkit for evaluation and investigation of numerical models for weather and climate applications.
https://metoffice.github.io/CSET/
Apache License 2.0
8 stars 1 forks source link

Document template variables rose edit section #670

Open jfrost-mo opened 1 month ago

jfrost-mo commented 1 month ago

What problem does your feature request solve?

The template variables section shows up in rose edit if a variable is added to the configuration without being put into another section, usually because it is no longer used. These can be confusing, as they often have no help text or other context.

Describe the solution you'd like

Configuration in the template variables section is harmless, as it will have no effect. We should document it in the sphinx docs so users are not confused.

Describe alternatives you've considered

I'm a little concerned about the discoverability of this documentation, but hopefully the search will be sufficient.