Skip to content

Commit 0d4999e

Browse files
committed
fix docs
1 parent 45e56c3 commit 0d4999e

2 files changed

Lines changed: 9 additions & 13 deletions

File tree

api/src/main.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -896,9 +896,8 @@ export interface PythonEnvironmentManagerRegistrationApi {
896896
*
897897
* @param manager Environment Manager implementation to register.
898898
* @param options Optional registration options.
899-
* @param options.extensionId The extension ID of the calling extension. This is used as a fallback when
900-
* automatic extension detection fails, such as during F5 debugging where the extension's file path
901-
* does not contain its marketplace ID. If automatic detection succeeds, this value is ignored.
899+
* @param options.extensionId The extension ID of the calling extension. When this is not specified,
900+
* or when the specified extension cannot be found, the extension ID will be automatically detected.
902901
* @returns A disposable that can be used to unregister the environment manager.
903902
* @see {@link EnvironmentManager}
904903
*/
@@ -1005,9 +1004,8 @@ export interface PythonPackageManagerRegistrationApi {
10051004
*
10061005
* @param manager Package Manager implementation to register.
10071006
* @param options Optional registration options.
1008-
* @param options.extensionId The extension ID of the calling extension. This is used as a fallback when
1009-
* automatic extension detection fails, such as during F5 debugging where the extension's file path
1010-
* does not contain its marketplace ID. If automatic detection succeeds, this value is ignored.
1007+
* @param options.extensionId The extension ID of the calling extension. When this is not specified,
1008+
* or when the specified extension cannot be found, the extension ID will be automatically detected.
10111009
* @returns A disposable that can be used to unregister the package manager.
10121010
* @see {@link PackageManager}
10131011
*/

src/api.ts

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved.
22
// Licensed under the MIT License.
33

4-
import {
4+
import type {
55
Disposable,
66
Event,
77
FileChangeType,
@@ -890,9 +890,8 @@ export interface PythonEnvironmentManagerRegistrationApi {
890890
*
891891
* @param manager Environment Manager implementation to register.
892892
* @param options Optional registration options.
893-
* @param options.extensionId The extension ID of the calling extension. This is used as a fallback when
894-
* automatic extension detection fails, such as during F5 debugging where the extension's file path
895-
* does not contain its marketplace ID. If automatic detection succeeds, this value is ignored.
893+
* @param options.extensionId The extension ID of the calling extension. When this is not specified,
894+
* or when the specified extension cannot be found, the extension ID will be automatically detected.
896895
* @returns A disposable that can be used to unregister the environment manager.
897896
* @see {@link EnvironmentManager}
898897
*/
@@ -999,9 +998,8 @@ export interface PythonPackageManagerRegistrationApi {
999998
*
1000999
* @param manager Package Manager implementation to register.
10011000
* @param options Optional registration options.
1002-
* @param options.extensionId The extension ID of the calling extension. This is used as a fallback when
1003-
* automatic extension detection fails, such as during F5 debugging where the extension's file path
1004-
* does not contain its marketplace ID. If automatic detection succeeds, this value is ignored.
1001+
* @param options.extensionId The extension ID of the calling extension. When this is not specified,
1002+
* or when the specified extension cannot be found, the extension ID will be automatically detected.
10051003
* @returns A disposable that can be used to unregister the package manager.
10061004
* @see {@link PackageManager}
10071005
*/

0 commit comments

Comments
 (0)