Skip to content

docs: improve documentation#144

Merged
vbreuss merged 2 commits into
mainfrom
topic/improve-documentation
Nov 1, 2025
Merged

docs: improve documentation#144
vbreuss merged 2 commits into
mainfrom
topic/improve-documentation

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Nov 1, 2025

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:

  • Updates documentation to reflect the current API (e.g., mock.Setup.Method.MethodName(...) instead of mock.Setup.MethodName(...), mock.Raise instead of mock.Raises)
  • Adds detailed examples for methods, properties, indexers, and events
  • Expands coverage of argument matchers, async methods, and verification patterns

@vbreuss vbreuss self-assigned this Nov 1, 2025
Copilot AI review requested due to automatic review settings November 1, 2025 17:01
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Nov 1, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 of mock.Setup.MethodName(...), mock.Raise instead of mock.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.

Comment thread Docs/pages/02-setup.md
Comment thread Docs/pages/02-setup.md
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 1, 2025

Test Results

   11 files  ±0     11 suites  ±0   1m 42s ⏱️ +15s
  918 tests ±0    917 ✅ ±0  1 💤 ±0  0 ❌ ±0 
6 127 runs  ±0  6 126 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit 5c58992. ± Comparison against base commit 57a070b.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 1, 2025

🚀 Benchmark Results

Details

BenchmarkDotNet v0.14.0, Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 10.0.100-rc.2.25502.107
[Host] : .NET 10.0.0 (10.0.25.50307), X64 RyuJIT AVX2

Job=InProcess Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=1 WarmupCount=10

Method Mean Error StdDev Gen0 Gen1 Allocated
Simple_Mockolate 1.209 μs 0.0167 μs 0.0139 μs 0.1984 - 3.24 KB
Simple_Moq 180.650 μs 0.9367 μs 0.8762 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.690 μs 0.0403 μs 0.0377 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.188 μs 0.0419 μs 0.0371 μs 0.4959 - 8.11 KB

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Nov 1, 2025

@vbreuss vbreuss enabled auto-merge (squash) November 1, 2025 17:28
@vbreuss vbreuss merged commit d369e3b into main Nov 1, 2025
12 checks passed
@vbreuss vbreuss deleted the topic/improve-documentation branch November 1, 2025 17:29
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 1, 2025

This is addressed in release v0.24.0.

@github-actions github-actions Bot added the state: released The issue is released label Nov 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create documentation site

2 participants