chore: comment truth sweep - #33
Merged
Merged
Conversation
… fix-markers - Delete the templated <example><code>var apiType = typeof(X);</code></example> filler line from 27 runtime files (pure padding, documents nothing) - QylInterceptedAzure: drop the CODE RED #9 past-bug marker; keep the live low-cardinality span-name constraint - QylSemConvRegistry: drop the 'previous substrate' history narration; keep the AOT-safety constraint that motivates the generator-emitted registry Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (27)
Cache: Disabled due to Reviews > Disable Cache setting Knowledge base: Disabled due to data retention organization setting 📝 WalkthroughSummary by CodeRabbit
WalkthroughRemoves XML documentation ChangesXML documentation cleanup
Estimated code review effort: 1 (Trivial) | ~5 minutes Doc comments trimmed, nothing broken — 25 files, zero logic touched, straight pass. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
There was a problem hiding this comment.
Pull request overview
Removes misleading or non-informative XML-doc/comment lines across the public runtime “surface” types, keeping only constraint-bearing documentation (notably AOT/trim safety and low-cardinality span naming) in this auto-instrumentation codebase.
Changes:
- Deleted templated
<example><code>var apiType = typeof(...)</code></example>XML-doc filler from many runtime-surface types. - Simplified/clarified the
QylInterceptedAzure.StartActivitycomment while preserving the low-cardinality span-name constraint. - Reworded
QylSemConvRegistryXML-doc to remove historical narration while keeping the AOT/trim constraint explanation.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylSemanticAttributes.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylNServiceBusMetrics.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylMetricNames.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedWcfCore.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedWcfClient.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedRedis.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedRabbitMq.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedQuartz.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedNServiceBus.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedMongoDb.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedMassTransit.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedLogger.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedKafka.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedHttpWebRequest.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedGrpcNetClient.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedGraphQl.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedExternalLogger.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedEntityFrameworkCore.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedElastic.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedDbCommand.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedAzure.cs | Removes XML-doc example filler and tightens span-name/tagging explanatory comment. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInterceptedAspNetCore.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylInstrumentationDomains.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylDbClientMetrics.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylAutoInstrumentationOptions.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/QylAutoInstrumentationIds.cs | Removes non-informative XML-doc example filler. |
| src/Qyl.OpenTelemetry.AutoInstrumentation/Internal/QylSemConvRegistry.cs | Rewords XML-doc to remove historical narration while preserving AOT/trim safety rationale. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Complete-and-verified.
Sweep of src + docs for lying, dead-pattern, fix-marker, and narration comments.
Deleted
<example><code>var apiType = typeof(X);</code></example>filler XML-doc line from 27 runtime files — documents nothing.QylInterceptedAzure.StartActivity: past-bug marker "(CODE RED deps: Update dependency NLog to 5.5.1 #9: the methodName parameter was previously received and dropped)" — kept the live low-cardinality span-name constraint.QylSemConvRegistry: "previous substrate built this with runtime assembly scanning ... now emits" history narration — kept the AOT-safety constraint (trim/AOT analyzers rejectAssembly.GetTypes()).Verified and kept
tempfile.TemporaryDirectory).Probe.csfixture comment left byte-identical: its call-site offsets are pinned in the verified generator snapshot.Evidence:
dotnet build Qyl.OpenTelemetry.AutoInstrumentation.slnx— Build succeeded, 0 warnings, 0 errors. No dotnet test projects exist in this repo by design (Python verifiers + snapshot fixture); no runtime-behavior surface was touched — comment/XML-doc lines only.🤖 Generated with Claude Code