Resolve TODO placeholders in Overview.md and configure.md - #16278
Merged
Azat Mukhametshin (azat-msft) merged 16 commits intoJul 16, 2026
Conversation
Complete the long-standing TODO/placeholder markers with source-grounded content instead of leaving them (or simply deleting the questions): Overview.md: - Replace the request/response format placeholder with the actual message documentation format (request payload, response payload, wire examples). - Document protocol version 5 (source marks it as having no protocol change). - Complete AttachmentSets vs RunAttachments: AttachmentSets are the per-run attachment sets collected during execution; RunAttachments on the payload holds run-level files such as TRX reports. - Describe the Package (test container) property and TranslationLayer extension points. - Remove stale author-notes already answered by surrounding text. configure.md: - Fill in the [mstest config] and [nunit config] reference links (were TODO), pointing at the current Learn MSTest and docs.nunit.org adapter-settings pages. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4e840b63-ad95-40c2-9ef8-5f2fcc4cfdaa
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 10:10
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to replace several TODO/placeholder markers with concrete, source-backed descriptions, primarily in the protocol and configuration docs.
Changes:
- Removes stale placeholder notes and fills in message documentation structure in
docs/Overview.md. - Adds protocol/versioning clarifications and expands several API/property descriptions in
docs/Overview.md. - Replaces
TODOreference links with concrete MSTest/NUnit configuration URLs indocs/configure.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/Overview.md | Replaces placeholders with detailed protocol/message documentation and clarifies several protocol/API notes. |
| docs/configure.md | Resolves placeholder reference links for MSTest/NUnit adapter configuration documentation. |
Jakub Jareš (nohwnd)
approved these changes
Jul 14, 2026
Jakub Jareš (nohwnd)
left a comment
Jakub Jareš (nohwnd)
left a comment
Member
There was a problem hiding this comment.
Ok as long as you capture the removed todos somewhere and fill them later.
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 14:28
View session
…deleting them - Protocol v5: document it as test-session support (MinimumProtocolVersionWithTestSessionSupport = 5) instead of 'reserved/unknown'. - DiscoveredExtensions: answer the 'since?' question (added in 17.2.0, not protocol-gated). - AreTestCaseLevelEventsRequired: explain what the flag does (per-test-case data collector events). - TranslationLayer extension points: enumerate the concrete IVsTestConsoleWrapper entry points. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: ca710943-7d44-480f-bdcd-8f431fa7dda5
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 14:41
View session
Replaces the removed '<TODO example?>' handling: the 'Message documentation' section now shows a concrete ProtocolVersion request/response example, and the 'Test Platform Protocol' intro links directly to that worked example. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: ca710943-7d44-480f-bdcd-8f431fa7dda5
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 14:54
View session
- Clarify RunAttachments vs AttachmentSets (run-context attachments, not TRX) - Soften protocol v5 description (const unused, test-session APIs removed) - Remove stale StartTestSession/StopTestSession TranslationLayer bullet - Give the Test Explorer image descriptive alt text Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: d94425b0-64f9-43cf-86ab-5fd683994c1a
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 15:27
View session
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 14, 2026 19:37
View session
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 15, 2026 14:05
View session
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 15, 2026 20:08
View session
- ProtocolVersion example: describe the unversioned envelope (Version is only emitted for v2+) and drop the 'both as a C# type' claim since the example only shows JSON. - DiscoveredExtensions: note the value can be null (e.g. before extension discovery populates TestPluginCache), so presence on the wire isn't guaranteed. - AttachmentSets: remove the TRX claim that contradicted the earlier RunAttachments description; keep the RunAttachments vs AttachmentSets distinction (runContextAttachments). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98e8b1b0-a115-4859-8b2e-9410cc399bef
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 15, 2026 20:29
View session
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 15, 2026 21:09
View session
… citation The original '// TODO: since?' asked which version introduced DiscoveredExtensions. Git history shows it was added in PR dotnet/vstest#3511 (2022-03-31), first shipped in v17.2.0 - so the earlier 'Added in 17.2.0' claim was accurate, it just lacked a citation. Restore the version with a verifiable source reference while keeping the not-version-gated / nullable serialization notes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98e8b1b0-a115-4859-8b2e-9410cc399bef
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 15, 2026 21:13
View session
Address review nit (nohwnd): consuming IVsTestConsoleWrapper is usage (you instantiate and call it), not extension. The callback interfaces you implement are the real extension points. Reframe the intro accordingly, add a '#### Usage: driving the wrapper' subsection with a concrete end-to-end example (adapted from the Playground), rename the callbacks subsection to '#### Extension points: interfaces you implement', and update the TOC. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98e8b1b0-a115-4859-8b2e-9410cc399bef
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 16, 2026 10:41
View session
- Note the vstest.console process starts lazily on the first operation (EnsureInitialized -> StartSession), so the sample works without an explicit StartSession() call. - Run by sources instead of discoveryHandler.TestCases: ITestDiscoveryEventsHandler(2) has no TestCases property (that was a custom Playground handler member), so the previous sample would not compile against the bare interface. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 98e8b1b0-a115-4859-8b2e-9410cc399bef
Copilot started reviewing on behalf of
Azat Mukhametshin (azat-msft)
July 16, 2026 10:49
View session
Azat Mukhametshin (azat-msft)
merged commit Jul 16, 2026
4ed742d
into
microsoft:main
16 checks passed
This file contains hidden or 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
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.
Resolves the long-standing
TODO/ placeholder markers in the docs with source-grounded content, instead of leaving them or simply deleting the open questions. Split out from a larger docs pass so the placeholder-resolution work is reviewable on its own.Overview.md
// 5: ???inProtocolVersioning).AttachmentSetsare the per-run attachment sets collected during execution;RunAttachmentson the enclosing payload holds run-level files such as TRX reports (verified againstTestRunCompletePayload/TestRunCompleteEventArgs).Package(test container) property and the TranslationLayer extension points.<TODO gif>, "fill in more details",<TODO example?>,// TODO: since?, "TODO: what is it?") that are already answered by the surrounding text.configure.md
[mstest config]and[nunit config]reference links (were literallyTODO), pointing at the current Learn MSTest configuration page and the docs.nunit.org adapter-settings page.