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

Update README re: desugaring #309

Merged
merged 1 commit into from
Apr 22, 2024

Conversation

bidetofevil
Copy link
Contributor

@bidetofevil bidetofevil commented Apr 21, 2024

Address issue #295 by updating the README to note the workaround required so desugaring on debug works properly to the Java semconv module's lack of direct dependency to the OTel Java API module.

If we want validate the workaround and ensure it keeps on working, I can add my instrumentation test and apply the workaround to the PR.

BTW, I'm not a big fan of the formatting, but I can't find a style guide to suggest something better. If you want me to turn the quoted paragraph to a call-out with two bullets or whatever, please let me know.

@bidetofevil bidetofevil requested a review from a team April 21, 2024 21:18
Copy link

linux-foundation-easycla bot commented Apr 21, 2024

CLA Signed


The committers listed above are authorized under a signed CLA.

@bidetofevil
Copy link
Contributor Author

Um, the auto formatting changed some formatting in the README. Let me know if they don't match the style guide and I can amend the PR.

Copy link
Contributor

@LikeTheSalad LikeTheSalad left a comment

Choose a reason for hiding this comment

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

LGTM!

@LikeTheSalad
Copy link
Contributor

LikeTheSalad commented Apr 22, 2024

Um, the auto formatting changed some formatting in the README. Let me know if they don't match the style guide and I can amend the PR.

I don't think we have defined a formatting style for md files yet, so for now, I wouldn't say there's a "proper" formatting. I think it's something we should add at some point though.

Copy link
Contributor

@breedx-splk breedx-splk left a comment

Choose a reason for hiding this comment

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

LGTM as well, thanks!

We definitely have markdown linting in other repos. I'll make an issue to track that, so that we can leverage the same here. Will be helpful as we start to flesh out documentation in the future.

@breedx-splk breedx-splk merged commit 21f0b11 into open-telemetry:main Apr 22, 2024
2 checks passed
@breedx-splk
Copy link
Contributor

#311

@bidetofevil bidetofevil deleted the desugaring branch May 12, 2024 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants