Add NamespaceDoc for DemaConsulting.TestResults and IO namespaces - #167
Merged
Malcolmnixon merged 3 commits intoJul 2, 2026
Merged
Conversation
Copilot created this pull request from a session on behalf of
Malcolmnixon
July 2, 2026 20:06
View session
Malcolmnixon
marked this pull request as ready for review
July 2, 2026 20:06
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds NamespaceDoc scaffolding types so ApiMark can generate namespace-level API documentation pages for the core DemaConsulting.TestResults namespace and the DemaConsulting.TestResults.IO namespace, and updates ReviewMark to include these files in the Purpose review-set.
Changes:
- Added
NamespaceDocforDemaConsulting.TestResultswith model/IO architecture description, usage examples, and behavioral contracts. - Added
NamespaceDocforDemaConsulting.TestResults.IOdocumenting the serializers, format detection, examples, and known JUnit round-trip limitations. - Updated
.reviewmark.yamlto include bothNamespaceDoc.csfiles in thePurposereview-set.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/DemaConsulting.TestResults/NamespaceDoc.cs | Adds namespace-level XML docs and examples for the in-memory model layer and its usage/contracts. |
| src/DemaConsulting.TestResults/IO/NamespaceDoc.cs | Adds namespace-level XML docs and examples for TRX/JUnit serializers and format detection behavior. |
| .reviewmark.yaml | Tracks the new documentation-only NamespaceDoc files under the Purpose review-set. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Malcolmnixon
deleted the
copilot/add-namespacedoc-for-dematconsulting-testresults
branch
July 2, 2026 21:43
This was referenced Jul 6, 2026
This was referenced Jul 13, 2026
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.
Pull Request
Description
Adds
NamespaceDocclasses to theDemaConsulting.TestResultsandDemaConsulting.TestResults.IOnamespaces so ApiMark generates rich namespace-level pages in the packaged API documentation. Both files are documentation scaffolding (internal static class NamespaceDoc) rather than software items, so they are tracked in thePurposereview-set rather than any unit-level review-set.src/DemaConsulting.TestResults/NamespaceDoc.cs— covers the two-layer model/IO architecture, all three model types (TestResults,TestResult,TestOutcome/TestOutcomeExtensions), build-and-serialize and read-and-inspect examples, default value guarantees, and thread-safety contract.src/DemaConsulting.TestResults/IO/NamespaceDoc.cs— covers all three serializer types (TrxSerializer,JUnitSerializer,Serializer) andTestResultFormat, guidance on when to use each serializer, examples for auto-detection, format identification, and explicit TRX/JUnit round-trips, JUnit round-trip loss caveats, and thread-safety contract..reviewmark.yaml— bothNamespaceDoc.csfiles added to thePurposereview-set.Type of Change
Related Issues
Pre-Submission Checklist
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes
NamespaceDocis a documentation-only convention; the class body is empty and the type isinternal, so it has no effect on the public API surface.