Skip to content
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

Add comments to attributable coverage #233709

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add comments to attributable coverage #233709

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
4 changes: 3 additions & 1 deletion src/vscode-dts/vscode.proposed.attributableCoverage.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ declare module 'vscode' {
* file. If set, then {@link TestRunProfile.loadDetailedCoverageForTest}
* should also be defined in order to retrieve detailed coverage information.
*/
fromTests: TestItem[];
fromTests?: TestItem[]; // TODO: `from` feels weird to me. Maybe `sourceTests` or `contributingTests` or even just `tests`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "includesTests" would be a good way to indicate this. That is quite descriptive as to what's going on here


constructor(
uri: Uri,
Expand All @@ -29,6 +29,8 @@ declare module 'vscode' {
* a test item is provided in {@link FileCoverage.fromTests} and only for
* files where such data is reported.
*
* // TODO: clarify how this works with `loadDetailedCoverage`. Does it replace `loadDetailedCoverage` or will it be called in addition to it?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to add to the above paragraph:

Often {@link TestRunProfile.loadDetailedCoverage} is called first when the user opens a file and overall coverage is displayed, then this method is called when they drill down into test-specific coverage.

*
* The editor will call this when user asks to view coverage for a test in
* a file, and the returned coverage information is used to display exactly
* what code was run by that test.
Expand Down
Loading