chore; Explain the reason for the disabled warning

jeromelaban · jeromelaban · commit 12e5bf87e36d · 2025-07-17T09:19:48.000-04:00
diff --git a/src/OpenTelemetry/Metrics/Reader/PeriodicExportingMetricReader.cs b/src/OpenTelemetry/Metrics/Reader/PeriodicExportingMetricReader.cs
@@ -103,7 +103,10 @@ protected override void Dispose(bool disposing)
         base.Dispose(disposing);
     }
 
+    // The pragma is required by the fact that this method is compiled on both .NET Framework and .NET Core, and the CA1859 warning is only relevant for .NET Framework.
+    // The warning suggests changing the return type to PeriodicExportingMetricReaderThreadWorker for improved performance, but we want to keep the method signature consistent across platforms.
 #pragma warning disable CA1859 // Change return type of method 'CreateWorker' from 'PeriodicExportingMetricReaderWorker' to 'PeriodicExportingMetricReaderThreadWorker' for improved performance
+
     private PeriodicExportingMetricReaderWorker CreateWorker()
 #pragma warning restore CA1859
     {

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,10 @@ protected override void Dispose(bool disposing)`
`103`	`103`	`base.Dispose(disposing);`
`104`	`104`	`}`
`105`	`105`
	`106`	`+ // The pragma is required by the fact that this method is compiled on both .NET Framework and .NET Core, and the CA1859 warning is only relevant for .NET Framework.`
	`107`	`+ // The warning suggests changing the return type to PeriodicExportingMetricReaderThreadWorker for improved performance, but we want to keep the method signature consistent across platforms.`
`106`	`108`	`#pragma warning disable CA1859 // Change return type of method 'CreateWorker' from 'PeriodicExportingMetricReaderWorker' to 'PeriodicExportingMetricReaderThreadWorker' for improved performance`
	`109`	`+`
`107`	`110`	`private PeriodicExportingMetricReaderWorker CreateWorker()`
`108`	`111`	`#pragma warning restore CA1859`
`109`	`112`	`{`