Fix comments in code to generate good XML file (Azure#18072)

azure-sdk · May 9, 2022 · fdbc302 · fdbc302
1 parent 1ed6933
commit fdbc302
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/src/Accounts/Accounts/Common/ScopeHelpers.cs b/src/Accounts/Accounts/Common/ScopeHelpers.cs
@@ -61,11 +61,12 @@ public static ContextModificationScope GetContextModificationScopeForProcess(Deb
         }
 
         /// <summary>
-        /// Get the context modification scope for the current user.  This will be 'Process' if changes should 
-        /// only affect the current PowerShell session, or 'CurrentUser'  if any changes should be global.
+        /// Get the context modification scope for the current user. This will be 'Process' if changes should 
+        /// only affect the current PowerShell session, or 'CurrentUser' if any changes should be global.
         /// </summary>
+        /// <param name="session"> The PowerShell session to be affected</param>
         /// <param name="writer">A writer to write debug messages</param>
-        /// <returns>'Process'  if all changes should only impact the current session, or 'CurrentUser' if 
+        /// <returns>'Process' if all changes should only impact the current session, or 'CurrentUser' if 
         /// changes should be global.</returns>
         public static ContextModificationScope GetContextModificationScopeForUser(IAzureSession session, DebugWriter writer)
         {

diff --git a/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs b/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs
@@ -102,21 +102,21 @@ public static TelemetryProvider Create(bool collect, IEventStore store)
         }
 
         /// <summary>
-        /// Log a telemtry event
+        /// Log a telemetry event
         /// </summary>
-        /// <param name="qosEvent">The event to log</param>
-        public virtual void LogEvent(string key)
+        /// <param name="qosEventKey">The event to log</param>
+        public virtual void LogEvent(string qosEventKey)
         {
             var dataCollection = _dataCollectionProfile.EnableAzureDataCollection;
             var enabled = dataCollection.HasValue ? dataCollection.Value : true;
 
-            AzurePSQoSEvent qos;
-            if (this.TryGetValue(key, out qos))
+            AzurePSQoSEvent qosEvent;
+            if (this.TryGetValue(qosEventKey, out qosEvent))
             {
-                qos.FinishQosEvent();
-                _helper.LogQoSEvent(qos, enabled, enabled);
+                qosEvent.FinishQosEvent();
+                _helper.LogQoSEvent(qosEvent, enabled, enabled);
                 _helper.FlushMetric();
-                this.Remove(key);
+                this.Remove(qosEventKey);
             }
         }