Skip to content

Commit c3c2423

Browse files
Add some doc comments (and fix a typo).
1 parent e32d716 commit c3c2423

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

src/client/common/process/internal.ts

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,37 @@ import { PythonVersionInfo } from './types';
88
// It is simpler to hard-code it instead of using vscode.ExtensionContext.extensionPath.
99
const SCRIPTS_DIR = path.join(EXTENSION_ROOT_DIR, 'pythonFiles');
1010

11+
/****************************
12+
* The following namespaces cover the following:
13+
*
14+
* * internal scripts under the top-level "pythonFiles" directory
15+
* * other internal uses of Python
16+
*
17+
* Unlike elsewhere in the extension code, we use namespaces here
18+
* to keep all these internal uses together in a concise manner.
19+
* ...
20+
****************************/
21+
22+
// "scripts" contains everything relevant to the scripts found under
23+
// the top-level "pythonFiles" directory. Each of those scripts has
24+
// a function in this namespace which matches the script's filename.
25+
// Each function provides the commandline arguments that should be
26+
// used when invoking a Python executable, whether through spawn/exec
27+
// or a terminal.
28+
//
29+
// Where relevant (nearly always), the function also returns a "parse"
30+
// function that may be used to deserialize the stdout of the script
31+
// into the corresponding object or objects. "parse()" takes a single
32+
// string as the stdout text and returns the relevant data.
33+
//
34+
// Some of the scripts are located in subdirectories of "pythonFiles".
35+
// For each of those subdirectories there is a sub-namespace where
36+
// those scripts' functions may be found.
37+
//
38+
// ignored scripts:
39+
// * install_debugpy.py (used only for extension development)
40+
// * ptvsd_launcher.py (used only for the old debug adapter)
1141
export namespace scripts {
12-
// ignored:
13-
// * install_debugoy.py
14-
// * ptvsd_launcher.py
15-
1642
//============================
1743
// interpreterInfo.py
1844

0 commit comments

Comments
 (0)