open-telemetry / opentelemetry-collector

OpenTelemetry Collector
https://opentelemetry.io
Apache License 2.0
3.94k stars 1.32k forks source link

Documentation improvements - Comments in key functions #10029

Closed ankitpatel96 closed 2 weeks ago

ankitpatel96 commented 3 weeks ago

Documentation

I wrote comments on a bunch of important functions that helped me understand how the collector works. I also created some other documentation in https://github.com/open-telemetry/opentelemetry-collector/pull/10068 - but split it up from this PR.

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.87%. Comparing base (7b046d9) to head (996ef1b). Report is 31 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #10029 +/- ## ========================================== + Coverage 91.65% 91.87% +0.21% ========================================== Files 360 360 Lines 16639 16725 +86 ========================================== + Hits 15251 15366 +115 + Misses 1053 1021 -32 - Partials 335 338 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.