Skip to content

Improve doc string for description of environment argument in API #20223

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
merged 1 commit into from
Nov 14, 2022
Merged

Improve doc string for description of environment argument in API #20223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/client/proposedApiTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ export interface ProposedExtensionAPI {
/**
* Sets the active environment path for the python extension for the resource. Configuration target will always
* be the workspace folder.
* @param environment : Full path to environment folder or python executable for the environment. Can also pass
* the environment itself.
* @param environment : If string, it represents the full path to environment folder or python executable
* for the environment. Otherwise it can be {@link Environment} or {@link EnvironmentPath} itself.
* @param resource : [optional] File or workspace to scope to a particular workspace folder.
*/
updateActiveEnvironmentPath(
Expand Down Expand Up @@ -55,8 +55,8 @@ export interface ProposedExtensionAPI {
refreshEnvironments(options?: RefreshOptions, token?: CancellationToken): Promise<void>;
/**
* Returns details for the given environment, or `undefined` if the env is invalid.
* @param environment : Full path to environment folder or python executable for the environment. Can also pass
* the environment itself.
* @param environment : If string, it represents the full path to environment folder or python executable
* for the environment. Otherwise it can be {@link Environment} or {@link EnvironmentPath} itself.
*/
resolveEnvironment(
environment: Environment | EnvironmentPath | string,
Expand Down