Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[SEMANTIC CONVENTIONS] Fix comment style to preserve markup #3444

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

Merged
merged 3 commits into from
May 28, 2025

Conversation

marcalff
Copy link
Member

@marcalff marcalff commented May 26, 2025

Fixes # (issue)

Changes

Please provide a brief description of the changes here.

Fixed the C++ comment style for generated code in semantic conventions (file weaver.yaml).

Before:

/**
 * line 1
 * line 2
 * line 3
*/

After:

/**
  line 1
  line 2
  line 3
*/

This preserve the text markup, when it contains embedded doxygen or html content.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

Copy link

netlify bot commented May 26, 2025

Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name Link
🔨 Latest commit 36265fc
🔍 Latest deploy log https://app.netlify.com/projects/opentelemetry-cpp-api-docs/deploys/6836aa85772f1e0008a90de8

@marcalff marcalff changed the title Fix comment style in semantic conventions. [SEMANTIC CONVENTIONS] Fix comment style to preserve markup. May 26, 2025
@marcalff marcalff marked this pull request as ready for review May 26, 2025 19:31
@marcalff marcalff requested a review from a team as a code owner May 26, 2025 19:31
@marcalff marcalff changed the title [SEMANTIC CONVENTIONS] Fix comment style to preserve markup. [SEMANTIC CONVENTIONS] Fix comment style to preserve markup May 26, 2025
@marcalff marcalff added the pr:please-review This PR is ready for review label May 26, 2025
Copy link

codecov bot commented May 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.88%. Comparing base (c3ef545) to head (36265fc).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3444   +/-   ##
=======================================
  Coverage   89.88%   89.88%           
=======================================
  Files         212      212           
  Lines        6941     6941           
=======================================
  Hits         6238     6238           
  Misses        703      703           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@psx95 psx95 left a comment

Choose a reason for hiding this comment

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

LGTM.
Went through the modified files and the changes match the PR description.

@marcalff marcalff merged commit 214950e into open-telemetry:main May 28, 2025
67 checks passed
malkia added a commit to malkia/opentelemetry-cpp that referenced this pull request May 28, 2025
[SEMANTIC CONVENTIONS] Fix comment style to preserve markup (open-telemetry#3444)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:please-review This PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants