OpenSimulationInterface / osi-documentation

This is the official main documentation for the open-simulation-interface organization based on sphinx
Other
14 stars 8 forks source link

ENUM conventions: Allow exceptions for "technical enums" #68

Closed RIFJo closed 6 months ago

RIFJo commented 1 year ago

The enum naming conventions have rules for required fields.

"The first enum field shall always use the suffix UNKNOWN. The second enum field shall always use the suffix OTHER."

This requirement, especially the presence of the "UNKNOWN" field is not useful for some enums with technical context - there are cases where it is correct to have a clearly defined default value, using the suffix "DEFAULT = 0" as first entry.

discussions here and here

We (the sensor modelling discussion group) suggest to rewrite the requirements to allow exceptions - for example

pmai commented 6 months ago

Closed by #72.