Skip to content
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

[sdk] Add missing XML comments and nullable decorations for public APIs #4840

Merged
merged 1 commit into from
Sep 8, 2023

Conversation

CodeBlanch
Copy link
Member

Changes

  • Removed <NoWarn>$(NoWarn),CS0618</NoWarn> from OpenTelemetry.Api csproj. That didn't seem to introduce any new warnings.
  • Removed <NoWarn>$(NoWarn),1591,CS0618</NoWarn> from OpenTelemetry csproj. This generated warnings for anything in public API missing XML docs. Added those docs.
  • Added nullable annotations for everything remaining in the OpenTelemetry public API. Mostly metric files/artifacts. There is still some internal stuff missing annotations before we can turn it on for the whole SDK project, follow-up effort for that.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)

@CodeBlanch CodeBlanch requested a review from a team September 8, 2023 06:01
@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #4840 (ecc511c) into main (459783f) will increase coverage by 0.02%.
The diff coverage is 94.64%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4840      +/-   ##
==========================================
+ Coverage   83.91%   83.94%   +0.02%     
==========================================
  Files         293      293              
  Lines       12001    12004       +3     
==========================================
+ Hits        10071    10077       +6     
+ Misses       1930     1927       -3     
Files Changed Coverage
src/OpenTelemetry/BaseExportProcessor.cs ø
src/OpenTelemetry/BatchExportProcessorOptions.cs ø
src/OpenTelemetry/CompositeProcessor.cs ø
...OpenTelemetry/Metrics/BaseExportingMetricReader.cs ø
...emetry/Metrics/Builder/MeterProviderBuilderBase.cs ø
...emetry/Metrics/Exemplar/AlwaysOffExemplarFilter.cs ø
...lemetry/Metrics/Exemplar/AlwaysOnExemplarFilter.cs ø
...emetry/Metrics/Exemplar/SimpleExemplarReservoir.cs 0.00%
...metry/Metrics/Exemplar/TraceBasedExemplarFilter.cs ø
src/OpenTelemetry/Metrics/ExportModesAttribute.cs ø
... and 21 more

📢 Thoughts on this report? Let us know!.

@utpilla utpilla merged commit 185d622 into open-telemetry:main Sep 8, 2023
@CodeBlanch CodeBlanch deleted the sdk-cleanup branch September 8, 2023 20:08
@CodeBlanch
Copy link
Member Author

Tag #3958

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants