Skip to content

Commit 8fe4d0b

Browse files
author
Kartik Raj
authored
Improve doc string for description of environment argument in API (#20223)
Closes #20220
1 parent db5e96c commit 8fe4d0b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/client/proposedApiTypes.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ export interface ProposedExtensionAPI {
1717
/**
1818
* Sets the active environment path for the python extension for the resource. Configuration target will always
1919
* be the workspace folder.
20-
* @param environment : Full path to environment folder or python executable for the environment. Can also pass
21-
* the environment itself.
20+
* @param environment : If string, it represents the full path to environment folder or python executable
21+
* for the environment. Otherwise it can be {@link Environment} or {@link EnvironmentPath} itself.
2222
* @param resource : [optional] File or workspace to scope to a particular workspace folder.
2323
*/
2424
updateActiveEnvironmentPath(
@@ -55,8 +55,8 @@ export interface ProposedExtensionAPI {
5555
refreshEnvironments(options?: RefreshOptions, token?: CancellationToken): Promise<void>;
5656
/**
5757
* Returns details for the given environment, or `undefined` if the env is invalid.
58-
* @param environment : Full path to environment folder or python executable for the environment. Can also pass
59-
* the environment itself.
58+
* @param environment : If string, it represents the full path to environment folder or python executable
59+
* for the environment. Otherwise it can be {@link Environment} or {@link EnvironmentPath} itself.
6060
*/
6161
resolveEnvironment(
6262
environment: Environment | EnvironmentPath | string,

0 commit comments

Comments
 (0)