Delete generated comments from examples#414
Merged
jack-berg merged 3 commits intoopen-telemetry:mainfrom Nov 17, 2025
Merged
Conversation
zeitlinger
approved these changes
Nov 17, 2025
codeboten
approved these changes
Nov 17, 2025
…y-configuration into delete-example-generated-comments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The files in
/examplescontain generated descriptions based onmeta_schema.yaml. This has been necessary because examples functioned as the only source of documentation for important information about semantics and default behavior, for both implementers and end users.With schema-docs.md we no longer need examples to document semantics and default behavior. And they now increasingly seem like annoying clutter.
This PR deletes the description comments and build tooling which automatically maintained them. I've added links to
/schema-docs.mdto the top of each example file.#397 further improves
schema-docs.mdand makes this a no brainer.Inspired by #402 (comment)