Skip to content

Commit 0fdc341

Browse files
author
Kartik Raj
committed
Update API description
1 parent fa3e1e9 commit 0fdc341

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/client/api.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,12 @@ export interface IExtensionApi {
3939
*/
4040
settings: {
4141
/**
42-
* Return the currently selected interpreter path.
43-
* @param {Resource} [resource]
42+
* Returns the Python interpreter path corresponding to the specified resource, taking into account
43+
* any workspace-specific settings for the workspace to which this resource belongs.
44+
* @param {Resource} [resource] A resource for which the setting is asked for.
45+
* * When a resource is provided, setting scoped to that resource is returned.
46+
* * Otherwise, the setting scoped to the first workspace folder is returned.
47+
* * If no folder is present, it returns the global setting.
4448
* @returns {string}
4549
*/
4650
getInterpreterPath(resource?: Resource): string;

0 commit comments

Comments
 (0)