Dates and durations in rose edit should have format examples

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

Dates and durations in rose edit should have format examples #667

Open jfrost-mo opened 1 month ago

jfrost-mo commented 1 month ago

What problem does your feature request solve?

While we use ISO 8601 dates and durations throughout CSET, we are not consistent about providing examples, and not everyone will be familiar with the standards.

Describe the solution you'd like

We should provide examples for the format visibly in rose edit, and preferably not buried in the hidden help text.

We may also want to document them in more detail in the sphinx documentation, to give something to link out to.

jfrost-mo commented 1 month ago

Some of the documentation refers to ISO standards. Whilst this is good and shows clear practice not everyone will have a clear recollection of what all the different standards are.
RECOMMENDATION: Each time an ISO standard is mentioned (even if the same one has been mentioned before) an example should be included.
RECOMMENDATION: These should be visible on the GUI without having to click for more information.