Skip to content

update create api doc string to be more explicit #819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Yoyokrazy merged 2 commits into from
Sep 10, 2025
Merged

update create api doc string to be more explicit #819

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09fcff7
update create api doc string to be more explicit
eleanorjboyd Sep 10, 2025
9947efa
Merge branch 'main' into yellow-butterfly
eleanorjboyd Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ export interface EnvironmentManager {
quickCreateConfig?(): QuickCreateConfig | undefined;

/**
* Creates a new Python environment within the specified scope. Create should support adding a .gitignore file if it creates a folder within the workspace.
* 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`.
* @param scope - The scope within which to create the environment.
* @param options - Optional parameters for creating the Python environment.
* @returns A promise that resolves to the created Python environment, or undefined if creation failed.
Expand Down
Loading