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

Escape square brackets that don’t represent a link #1417

Closed
wants to merge 1 commit into from

Conversation

lquerel
Copy link
Contributor

@lquerel lquerel commented Sep 18, 2024

Square brackets are often used to specify a range in metrics. However, without escaping them, Markdown-based documentation interprets these as links. This PR addresses the issue by escaping such square brackets, ensuring they are displayed correctly as plain text.

This change is similar to PR #1416.

@lquerel
Copy link
Contributor Author

lquerel commented Sep 18, 2024

@lmolkova pointed out that this part of the markdown "spec" is ambiguous, and most markdown linters accept these links (except for example cargo doc). Therefore, we decided to create a new configuration in Weaver to automatically correct these links when used in the context of code generation, such as in the Rust codegen. See this Weaver issue for more details open-telemetry/weaver#374

@lquerel lquerel closed this Sep 18, 2024
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.

2 participants