Add comments

microsoft · Feb 5, 2024 · c86c03e · c86c03e
1 parent 6b8f19f
commit c86c03e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsReducer.ts b/src/client/pythonEnvironments/base/locators/composite/envsReducer.ts
@@ -55,6 +55,8 @@ async function* iterEnvsIterator(
             if (isProgressEvent(event)) {
                 if (event.stage === ProgressReportStage.discoveryFinished) {
                     state.done = true;
+                    // For super slow locators such as Windows registry, we expect updates even after discovery
+                    // is "officially" finished, hence do not dispose listeners.
                     // listener.dispose();
                 } else {
                     didUpdate.fire(event);
@@ -122,7 +124,6 @@ function checkIfFinishedAndNotify(
 ) {
     if (state.done && state.pending === 0) {
         didUpdate.fire({ stage: ProgressReportStage.discoveryFinished });
-        // didUpdate.dispose();
         traceVerbose(`Finished with environment reducer`);
         state.done = false; // No need to notify again.
     }

diff --git a/src/client/pythonEnvironments/base/locators/composite/envsResolver.ts b/src/client/pythonEnvironments/base/locators/composite/envsResolver.ts
@@ -87,6 +87,8 @@ export class PythonEnvsResolver implements IResolvingLocator {
                     if (event.stage === ProgressReportStage.discoveryFinished) {
                         didUpdate.fire({ stage: ProgressReportStage.allPathsDiscovered });
                         state.done = true;
+                        // For super slow locators such as Windows registry, we expect updates even after discovery
+                        // is "officially" finished, hence do not dispose listeners.
                         // listener.dispose();
                     } else {
                         didUpdate.fire(event);
@@ -172,7 +174,6 @@ function checkIfFinishedAndNotify(
 ) {
     if (state.done && state.pending === 0) {
         didUpdate.fire({ stage: ProgressReportStage.discoveryFinished });
-        // didUpdate.dispose();
         traceVerbose(`Finished with environment resolver`);
     }
 }