Skip to content

Commit 69ff9d4

Browse files
authored
update create api doc string to be more explicit (#819)
1 parent 93217b7 commit 69ff9d4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ export interface EnvironmentManager {
379379
quickCreateConfig?(): QuickCreateConfig | undefined;
380380

381381
/**
382-
* Creates a new Python environment within the specified scope. Create should support adding a .gitignore file if it creates a folder within the workspace.
382+
* Creates a new Python environment within the specified scope. Create should support adding a .gitignore file if it creates a folder within the workspace. If a manager does not support environment creation, do not implement this method; the UI disables "create" options when `this.manager.create === undefined`.
383383
* @param scope - The scope within which to create the environment.
384384
* @param options - Optional parameters for creating the Python environment.
385385
* @returns A promise that resolves to the created Python environment, or undefined if creation failed.

0 commit comments

Comments
 (0)