Documentation Updates #2720
Merged
Documentation Updates #2720
Conversation
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
- Fixed version placeholder in installation.md (changed from $(TUnitVersion) to *) - Fixed syntax error in depends-on.md array syntax - Created advanced/extension-points.md documenting ITestExecutor, IHookExecutor, and event receivers - Created advanced/exception-handling.md with complete exception hierarchy documentation - Created test-authoring/generic-attributes.md for type-safe generic attribute usage - Created troubleshooting.md with common issues and solutions - Created advanced/performance-best-practices.md for test performance optimization - Enhanced test-context.md with service provider integration documentation - Enhanced awaiting.md with extensive complex assertion examples These improvements address missing documentation for key TUnit features and provide clearer guidance for developers with practical examples and best practices. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Changed UseTestExecutor to TestExecutor (the correct attribute name) - Changed RegisterEventReceiver to proper attribute-based registration - Added examples showing event receivers are implemented as attributes 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
thomhurst
had a problem deploying
to
Pull Requests
GitHub Actions
Failure
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on enhancing TUnit's documentation with comprehensive guides and examples. The main purpose is to provide developers with detailed reference materials covering troubleshooting, advanced usage patterns, and practical examples.
- Added extensive troubleshooting guide covering common issues and their solutions
- Enhanced assertion examples with complex scenarios and patterns
- Introduced documentation for dependency injection with TestContext
- Added comprehensive guides for advanced topics like performance optimization, extension points, and exception handling
- Created detailed documentation for generic attributes and their type-safe benefits
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
docs/docs/troubleshooting.md |
New comprehensive troubleshooting guide with 548 lines covering test discovery, execution issues, assertion failures, and platform-specific problems |
docs/docs/test-lifecycle/test-context.md |
Added service provider integration section explaining dependency injection access through TestContext |
docs/docs/test-authoring/generic-attributes.md |
New guide documenting generic attribute versions with type safety benefits and AOT compatibility |
docs/docs/test-authoring/depends-on.md |
Updated DependsOn attribute syntax to use modern C# array initialization |
docs/docs/getting-started/installation.md |
Simplified .csproj example to use wildcard version for TUnit package |
docs/docs/assertions/awaiting.md |
Enhanced with 287 lines of complex assertion examples covering chaining, collections, async operations, and performance testing |
docs/docs/advanced/performance-best-practices.md |
New comprehensive performance guide with optimization strategies for test discovery, execution, and CI/CD |
docs/docs/advanced/extension-points.md |
New detailed guide covering all TUnit extension interfaces and implementation patterns |
docs/docs/advanced/exception-handling.md |
New comprehensive exception handling guide covering TUnit's exception hierarchy and best practices |
- Fixed ITestDiscoveryEventReceiver to have only OnTestDiscovered method - Changed all event receiver methods to return ValueTask instead of Task - Fixed parameter types (TestRegisteredContext, no TestResult in OnTestEnd) - Fixed ITestRetryEventReceiver signature (only context and retryAttempt) - Updated example to show event receivers as attributes with correct signatures 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
thomhurst
had a problem deploying
to
Pull Requests
GitHub Actions
Failure
- Escaped <T> to <T> in all generic attribute headings - Prevents MDX from interpreting <T> as an HTML tag 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
thomhurst
requested a deployment
to
Pull Requests
GitHub Actions
In progress
- Added detailed section on nested property injection with automatic initialization - Included real-world example with test containers and WebApplicationFactory - Documented how TUnit resolves dependency graphs and manages object lifetimes - Added best practices and sharing strategies - Covered advanced scenarios including circular dependency detection This powerful feature enables advanced test orchestration with simple code, letting TUnit handle initialization order and object lifetimes automatically. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
This was referenced Aug 6, 2025
Open
This was referenced Sep 23, 2025
This was referenced Oct 1, 2025
This was referenced Oct 8, 2025
This was referenced Oct 16, 2025
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.
Enhanced Assertion Examples:
docs/docs/assertions/awaiting.mdwith detailed examples for complex assertions, including chaining, collection conditions, async operations, nested objects, exception details, and performance metrics. These examples demonstrate the flexibility of TUnit's assertion system.Dependency Injection with
TestContext:docs/docs/test-lifecycle/test-context.mdexplaining how to useTestContextto access dependency injection services. Examples include accessing loggers, working with scoped services, and integrating services in custom extensions and test lifecycle hooks.Code Consistency and Fixes:
DependsOnattribute syntax indocs/docs/test-authoring/depends-on.mdto usenew[]for specifying types, improving clarity and alignment with modern C# practices..csprojexample indocs/docs/getting-started/installation.mdto use a wildcard for the TUnit version, simplifying the setup process.