Most enum members in the schema packages have no documentation at all. A handful have inline # comments.
For a schema, enum values are part of the public contract: consumers deciding between unclassified and residential, or path and track, shouldn't need to reverse-engineer the conventions. Every member whose meaning isn't self-evident from its name should carry a short docstring.
Scope:
- Migrate Enum classes to DocumentedEnum where member docs are warranted.
- Write documentation for members that never had any.
- Self-evident members (e.g. CAR = "car") can stay undocumented; DocumentedEnum supports that per-member.
This can land incrementally
Most enum members in the schema packages have no documentation at all. A handful have inline # comments.
For a schema, enum values are part of the public contract: consumers deciding between unclassified and residential, or path and track, shouldn't need to reverse-engineer the conventions. Every member whose meaning isn't self-evident from its name should carry a short docstring.
Scope:
This can land incrementally