Update README re: desugaring#309
Merged
breedx-splk merged 1 commit intoopen-telemetry:mainfrom Apr 22, 2024
Merged
Conversation
The committers listed above are authorized under a signed CLA. |
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. |
marandaneto
approved these changes
Apr 22, 2024
Contributor
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. |
breedx-splk
approved these changes
Apr 22, 2024
Contributor
breedx-splk
left a comment
breedx-splk
left a comment
There was a problem hiding this comment.
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.
Contributor
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
4 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.
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.