Add description

microsoft · Sep 21, 2020 · 557249b · 557249b
1 parent 24a9522
commit 557249b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/client/pythonEnvironments/discovery/locators/services/pyenvLocator.ts b/src/client/pythonEnvironments/discovery/locators/services/pyenvLocator.ts
@@ -12,6 +12,10 @@ import { pathExists } from '../../../common/externalDependencies';
  * @returns {boolean}: Returns true if the interpreter belongs to a pyenv environment.
  */
 export async function isPyenvEnvironment(interpreterPath:string): Promise<boolean> {
+    // Check if the pyenv environment variables exist: PYENV on Windows, PYENV_ROOT on Unix.
+    // They contain the path to pyenv's installation folder.
+    // If they don't exist, use the default path: ~/.pyenv/pyenv-win on Windows, ~/.pyenv on Unix.
+    // If the interpreter path starts with the path to the pyenv folder, then it is a pyenv environment.
     const isWindows = getOSType() === OSType.Windows;
     const envVariable = isWindows ? 'PYENV' : 'PYENV_ROOT';
     let pyenvDir = getEnvironmentVariable(envVariable);