Add comments explaining suppressed warnings in api common

[Gosling-dude]

Adds brief comments explaining why certain warnings are intentionally suppressed in the api common module.

No functional changes.
Fixes #7874.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.12%. Comparing base (7b2161c) to head (3634e2d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #7951      +/-   ##
============================================
- Coverage     90.14%   90.12%   -0.03%     
+ Complexity     7467     7465       -2     
============================================
  Files           834      834              
  Lines         22586    22586              
  Branches       2240     2240              
============================================
- Hits          20360    20355       -5     
- Misses         1527     1530       +3     
- Partials        699      701       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jkwatson]

generic types don't survive into compiled code, so this has nothing to do with allocations that I know of.

[Gosling-dude]

generic types don't survive into compiled code, so this has nothing to do with allocations that I know of.

Good catch, thanks for pointing that out. You're right, the allocation comment isn't accurate here. I'll update the comment to focus only on the type-safety guarantee.

[otelbot]

Thank you for your contribution @Gosling-dude! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

[zeitlinger]

It would be good to change the tooling to make sure an entire module is covered, e.g. by adding a property to the build file.