Skip to content

refactor: move example from otelgin to make it a testable example #7328

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 5 commits into from
May 19, 2025

Conversation

mcapell
Copy link
Contributor

@mcapell mcapell commented May 15, 2025

Following this PR, this moves the example from otelgin to be displayed in godocs.

Resolves: #7063

Move the example from otelgin to be displayed in godocs.

Resolves: open-telemetry#7063
@mcapell mcapell requested a review from a team as a code owner May 15, 2025 17:43
Copy link

linux-foundation-easycla bot commented May 15, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@github-actions github-actions bot requested review from akats7 and flc1125 May 15, 2025 17:43
@mcapell mcapell mentioned this pull request May 15, 2025
@MrAlias MrAlias added the blocked: CLA Waiting on CLA to be signed before progress can be made label May 15, 2025
@MrAlias

This comment was marked as outdated.

@MrAlias MrAlias removed the blocked: CLA Waiting on CLA to be signed before progress can be made label May 15, 2025
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.4%. Comparing base (878b3a7) to head (92377a1).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main   #7328     +/-   ##
=======================================
+ Coverage   81.2%   81.4%   +0.2%     
=======================================
  Files        207     206      -1     
  Lines      18275   18230     -45     
=======================================
  Hits       14845   14845             
+ Misses      3008    2963     -45     
  Partials     422     422             

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MrAlias MrAlias added the Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG label May 15, 2025
@flc1125
Copy link
Member

flc1125 commented May 16, 2025

Thank you for your contribution.

I don't think we need to remove the examples. What I believe we should do is: simply add examples based on the pkg.go.dev documentation (similar to the example_test.go format).

Just wanted to confirm, is this what we need? @pellared

@flc1125
Copy link
Member

flc1125 commented May 16, 2025

PS: To facilitate testing whether the desired effect is achieved, you can use this tool for debugging: https://github.com/golang/pkgsite

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

This also follows: #7118

@dmathieu dmathieu merged commit a35d2d8 into open-telemetry:main May 19, 2025
27 checks passed
@MrAlias MrAlias added this to the v1.36.0 milestone May 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example for otelgin
5 participants