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

Changed ruleset for Enum types. #72

Closed thempen closed 6 months ago

thempen commented 8 months ago

The ruleset for enum definition "shall" is not useful in many cases where "UNKNOWN" and "OTHER" is more confusing than helpful. So it should only be a recommendation for future implmentations.

Reference to a related issue in the repository

There are already multiple enums without the UNKNOWN and OTHER definition, like in https://github.com/OpenSimulationInterface/open-simulation-interface/blob/master/osi_motionrequest.proto. There are also current PRs where the current definition is appropriate.

Add a description

The rule to add "UNKNOWN" and "OTHER" should only be a recommendation in the future.

Mention a member

@thempen

Check the checklist

pmai commented 6 months ago

CCB 2024-03-11: Merge as-is.