Skip to content

Don't render deprecated enum members#1764

Merged
lmolkova merged 2 commits intoopen-telemetry:mainfrom
lmolkova:dont-render-deprecated-enum-props
Jan 22, 2025
Merged

Don't render deprecated enum members#1764
lmolkova merged 2 commits intoopen-telemetry:mainfrom
lmolkova:dont-render-deprecated-enum-props

Conversation

@lmolkova
Copy link
Copy Markdown
Member

I think this was the intention - I don't see a reason why we want to render them (they should remain in yaml for history and codegen though). Plus it results in weird things like this #1757 (comment)

Merge requirement checklist

@lmolkova lmolkova requested review from a team as code owners January 18, 2025 01:16
@lmolkova lmolkova changed the title Don't render deprecated enum properties Don't render deprecated enum members Jan 18, 2025
@lmolkova lmolkova added the Skip Changelog Label to skip the changelog check label Jan 18, 2025
Comment thread templates/registry/markdown/enum_macros.j2
Copy link
Copy Markdown
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to not render them and by keeping them in YAML it also prevents people from accidentally re-introducing them.
Alternatively we could also render them in a separate section or move them to the end of the table, but this might just bulk up markdown further.

@lmolkova lmolkova merged commit 68b0afa into open-telemetry:main Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog Label to skip the changelog check

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants