Add comments to attributable coverage #233709
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
connor4312
reviewed
Nov 19, 2024
| @@ -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.
I think "includesTests" would be a good way to indicate this. That is quite descriptive as to what's going on here
connor4312
reviewed
Nov 19, 2024
| @@ -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.
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.
connor4312
added a commit
that referenced
this pull request
Nov 25, 2024
connor4312
added a commit
that referenced
this pull request
Nov 25, 2024
connor4312
added a commit
that referenced
this pull request
Nov 25, 2024
connor4312
added a commit
that referenced
this pull request
Nov 26, 2024
* Add comments to attributable coverage * testing: apply coverage comments for attributable coverage Refs #233709 --------- Co-authored-by: Matt Bierner <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding some comments and minor tweaks to proposal