-
Notifications
You must be signed in to change notification settings - Fork 114
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: add relevant links to spec in doc blocks #821
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #821 +/- ##
=======================================
Coverage 17.32% 17.32%
=======================================
Files 24 24
Lines 710 710
=======================================
Hits 123 123
Misses 587 587
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is great!
Is there a reason you picked 1.8.0 to link to? Are we that behind on what spec is followed?
I chose it to align specifically with what's mentioned in the README. I can go ahead and look at the latest version of the spec and see if there are any major discrepancies that we'd have to account for 🕵️ |
@tsloughter I compared the links on 1.8 to whats on 1.41 and it seems like we can use the latest and update things. The link paths change in some cases (e.g. https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/context/context.md -> https://github.com/open-telemetry/opentelemetry-specification/blob/v1.41.0/specification/context/README.md), but it wouldn't be a huge effort to swap everything. I'd ultimately want to spend quite a bit more time and make sure I didn't miss anything though 😅 |
Aaah, I gotcha. It is up to you then. I'd be happy to have the latest links but its ok if you want to have it merged as it is. |
Just a suggestion. The other language libraries tend to link directly to the spec to see what the underlying operations map to and I figured we could do the same.