Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Fixed Bug: Examples rendering is broken in 1.26 release for array types #1088

Merged
merged 6 commits into from
Jun 6, 2024

Conversation

jerbly
Copy link
Contributor

@jerbly jerbly commented May 28, 2024

In the 1.26 release the markdown rendering of attribute examples is broken for array types.

An example for a string[] attribute type should be displayed as an array: ["a", "b"]. In 1.26 they are shown as multiple examples appropriate for string type: a; b.

This bug is due to the change to the jinja templates now driven by weaver.

I have fixed the jinja template and run the markdown generation.

Merge requirement checklist

@jerbly jerbly requested review from a team May 28, 2024 22:55
docs/attributes-registry/aws.md Show resolved Hide resolved
docs/attributes-registry/tls.md Outdated Show resolved Hide resolved
docs/attributes-registry/tls.md Outdated Show resolved Hide resolved
templates/registry/markdown/attribute_macros.j2 Outdated Show resolved Hide resolved
templates/registry/markdown/attribute_macros.j2 Outdated Show resolved Hide resolved
Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

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

thanks! interesting that it took long to realise this error in formatting :)

@lmolkova lmolkova merged commit 78db110 into open-telemetry:main Jun 6, 2024
12 checks passed
@jerbly jerbly deleted the fix-examples-jinja-macro branch June 6, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants