Better comments

microsoft · Oct 30, 2024 · f532a7d · f532a7d
1 parent f796118
commit f532a7d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/dev/index.d.ts b/dev/index.d.ts
@@ -222,6 +222,11 @@ export declare class TestUserInput {
     public readonly onDidFinishPrompt: Event<PromptResult>;
 
     public constructor(vscode: typeof import('vscode'));
+
+    /**
+     * Boolean set to indicate whether the UI is being used for test inputs. For`TestUserInput`, this will always default to true.
+     * See: https://github.com/microsoft/vscode-azuretools/pull/1807
+     */
     readonly isTesting: boolean;
 
     /**

diff --git a/dev/src/TestUserInput.ts b/dev/src/TestUserInput.ts
@@ -23,6 +23,10 @@ export class TestUserInput implements types.TestUserInput {
     private readonly _vscode: typeof vscodeTypes;
     private _inputs: (string | RegExp | TestInput)[] = [];
 
+    /**
+     * Boolean set to indicate whether the UI is being used for test inputs. For`TestUserInput`, this will always default to true.
+     * See: https://github.com/microsoft/vscode-azuretools/pull/1807
+     */
     readonly isTesting: boolean = true;
 
     constructor(vscode: typeof vscodeTypes) {

diff --git a/utils/src/wizard/AzureWizard.ts b/utils/src/wizard/AzureWizard.ts
@@ -114,6 +114,7 @@ export class AzureWizard<T extends (IInternalActionContext & Partial<types.Execu
 
                     if (loadingQuickPick) {
                         disposables.push(loadingQuickPick?.onDidHide(() => {
+                            // Avoid issuing cancels during tests - see: https://github.com/microsoft/vscode-azuretools/pull/1807
                             if (!this._context.ui.isPrompting && !this._context.ui.isTesting) {
                                 this._cancellationTokenSource.cancel();
                             }