-
Notifications
You must be signed in to change notification settings - Fork 29.5k
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.
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
base: main
Are you sure you want to change the base?
Conversation
@@ -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` |
There was a problem hiding this comment.
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
@@ -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? |
There was a problem hiding this comment.
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.
* Add comments to attributable coverage * testing: apply coverage comments for attributable coverage Refs #233709 --------- Co-authored-by: Matt Bierner <[email protected]>
Adding some comments and minor tweaks to proposal