Skip to content

[CHORE] Convert inline enum member comments to DocumentedEnum docstrings#562

Merged
Victor Schappert (vcschapp) merged 1 commit into
mainfrom
documented-enums
Jul 15, 2026
Merged

[CHORE] Convert inline enum member comments to DocumentedEnum docstrings#562
Victor Schappert (vcschapp) merged 1 commit into
mainfrom
documented-enums

Conversation

@RoelBollens-TomTom

Copy link
Copy Markdown
Collaborator

Converts enum member documentation that previously lived in Python # comments into DocumentedEnum member docstrings, so it is available at runtime and can be picked up by codegen and the generated site documentation.

Touched enums (only those that already had inline comments):

  • common/scoping/travel_mode.py: TravelMode
  • transportation/enums.py: RoadClass, RailClass, DestinationSignSymbol, RoadFlag, RailFlag, Subclass

Notes

  • This is a minimal, mechanical conversion: no documentation was added or reworded beyond small cleanups. Members without a comment stay undocumented. No schema/value changes, enum values are identical, so this is non-breaking.
  • Follow-up: Document all enum members #561

@github-actions

github-actions Bot commented Jul 15, 2026

Copy link
Copy Markdown

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/562/schema/index.html
🕐 Updated Jul 15, 2026 16:31 UTC
📝 Commit 82e5dd1
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

Signed-off-by: Roel <75250264+RoelBollens-TomTom@users.noreply.github.com>
@vcschapp
Victor Schappert (vcschapp) merged commit 5ef7627 into main Jul 15, 2026
19 checks passed
@vcschapp
Victor Schappert (vcschapp) deleted the documented-enums branch July 15, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document all enum members

3 participants