update comments for telemetry events (microsoft#155525)

Author: sbatten

src/vs/workbench/browser/parts/activitybar/activitybarActions.ts

@@ -103,8 +103,9 @@ export class ViewContainerActivityAction extends ActivityAction {
 	private logAction(action: string) {
 		type ActivityBarActionClassification = {
 			owner: 'sbatten';
-			viewletId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
-			action: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
+			comment: 'Event logged when an activity bar action is triggered.';
+			viewletId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The view in the activity bar for which the action was performed.' };
+			action: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The action that was performed. e.g. "hide", "show", or "refocus"' };
 		};
 		this.telemetryService.publicLog2<{ viewletId: String; action: String }, ActivityBarActionClassification>('activityBarAction', { viewletId: this.activity.id, action });
 	}

src/vs/workbench/contrib/experiments/common/experimentService.ts

@@ -307,7 +307,8 @@ export class ExperimentService extends Disposable implements IExperimentService
 			return Promise.all(promises).then(() => {
 				type ExperimentsClassification = {
 					owner: 'sbatten';
-					experiments: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
+					comment: 'Information about the experiments in this session';
+					experiments: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The list of experiments in this session' };
 				};
 				this.telemetryService.publicLog2<{ experiments: string[] }, ExperimentsClassification>('experiments', { experiments: this._experiments.map(e => e.id) });
 			});

src/vs/workbench/contrib/tags/electron-sandbox/workspaceTags.ts

@@ -67,7 +67,7 @@ export class WorkspaceTags implements IWorkbenchContribution {
 			value = 'Unknown';
 		}
 
-		this.telemetryService.publicLog2<{ edition: string }, { owner: 'sbatten'; edition: { classification: 'SystemMetaData'; purpose: 'BusinessInsight' } }>('windowsEdition', { edition: value });
+		this.telemetryService.publicLog2<{ edition: string }, { owner: 'sbatten'; comment: 'Information about the Windows edition.'; edition: { classification: 'SystemMetaData'; purpose: 'BusinessInsight'; comment: 'The Windows edition.' } }>('windowsEdition', { edition: value });
 	}
 
 	private async getWorkspaceInformation(): Promise<IWorkspaceInformation> {