Skip to content

Commit 16d3c2d

Browse files
authored
Updated API discussion points (microsoft#203723)
1 parent e9ce823 commit 16d3c2d

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

src/vscode-dts/vscode.proposed.debugVisualization.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ declare module 'vscode' {
3737
* the data provider, it will replace the variable in its tree.
3838
* Otherwise, the items will be shown as children of the variable.
3939
*/
40+
// @API don't return TreeDataProvider but a reference to it, like its ids
4041
visualization?: Command | TreeDataProvider<unknown>;
4142

4243
/**

src/vscode-dts/vscode.proposed.quickPickSortByLabel.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ declare module 'vscode' {
1111
/**
1212
* An optional flag to sort the final results by index of first query match in label. Defaults to true.
1313
*/
14+
// @API is a bug that we need this API at all. why do we change the sort order
15+
// when extensions give us a (sorted) array of items?
16+
// @API sortByLabel isn't a great name
1417
sortByLabel: boolean;
1518
}
1619
}

src/vscode-dts/vscode.proposed.testCoverage.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ declare module 'vscode' {
2626
* @param token A cancellation token.
2727
* @return Coverage metadata for all files involved in the test.
2828
*/
29+
// @API - pass something into the provide method:
30+
// (1) have TestController#coverageProvider: TestCoverageProvider
31+
// (2) pass TestRun into this method
2932
provideFileCoverage(token: CancellationToken): ProviderResult<T[]>;
3033

3134
/**
@@ -118,6 +121,9 @@ declare module 'vscode' {
118121
);
119122
}
120123

124+
// @API are StatementCoverage and BranchCoverage etc really needed
125+
// or is a generic type with a kind-property enough
126+
121127
/**
122128
* Contains coverage information for a single statement or line.
123129
*/

0 commit comments

Comments
 (0)