docs: improve documentation#144
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances and expands the Mockolate documentation by adding comprehensive guides for mock creation, setup, events, and verification. The documentation has been restructured into separate pages and added to the solution file for better organization.
- Updates documentation to reflect the current API (e.g.,
mock.Setup.Method.MethodName(...)instead ofmock.Setup.MethodName(...),mock.Raiseinstead ofmock.Raises) - Adds detailed examples for methods, properties, indexers, and events
- Expands coverage of argument matchers, async methods, and verification patterns
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Mockolate.sln | Adds a new "Docs" solution folder containing documentation pages |
| Docs/pages/01-mock-creation.md | Comprehensive guide to creating mocks with constructor parameters, behaviors, and factories |
| Docs/pages/02-setup.md | Detailed documentation for setting up methods, properties, and indexers with callbacks and matchers |
| Docs/pages/03-events.md | Updated event raising documentation with corrected API usage (Raise instead of Raises) |
| Docs/pages/04-verification.md | Expanded verification documentation covering methods, properties, indexers, events, and call ordering |
Comments suppressed due to low confidence (1)
Docs/pages/04-verification.md:1
- The en dash character (–) used in the bullet points should be replaced with a standard hyphen (-) for consistency and to avoid potential encoding issues in different text editors and viewers.
# Verify mock interactions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
🚀 Benchmark ResultsDetails
|
|
|
This is addressed in release v0.24.0. |



This PR enhances and expands the Mockolate documentation by adding comprehensive guides for mock creation, setup, events, and verification. The documentation has been restructured into separate pages and added to the solution file for better organization.
Key changes:
mock.Setup.Method.MethodName(...)instead ofmock.Setup.MethodName(...),mock.Raiseinstead ofmock.Raises)