Skip to content

Comments

docs: document advanced MockBehavior configuration options#439

Merged
vbreuss merged 2 commits intomainfrom
topic/document-advanced-mockbehavior-options
Jan 31, 2026
Merged

docs: document advanced MockBehavior configuration options#439
vbreuss merged 2 commits intomainfrom
topic/document-advanced-mockbehavior-options

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 31, 2026

This PR enhances the documentation for advanced MockBehavior configuration options in Mockolate. It adds detailed explanations for several MockBehavior features that were previously undocumented or insufficiently described.

Key Changes:

  • Document the counter parameter option for Initialize<T>() callbacks
  • Add documentation and examples for .WithDefaultValueFor<T>() method
  • Document the .UseConstructorParametersFor<T>() configuration method
  • Normalize ellipsis characters from ... to for consistency

@vbreuss vbreuss self-assigned this Jan 31, 2026
Copilot AI review requested due to automatic review settings January 31, 2026 11:38
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 2026
Copy link

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 the documentation for advanced MockBehavior configuration options in Mockolate. It adds detailed explanations for several MockBehavior features that were previously undocumented or insufficiently described.

Changes:

  • Document the counter parameter option for Initialize<T>() callbacks
  • Add documentation and examples for .WithDefaultValueFor<T>() method
  • Document the .UseConstructorParametersFor<T>() configuration method
  • Normalize ellipsis characters from ... to for consistency

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
README.md Added comprehensive documentation for MockBehavior configuration options and normalized ellipsis usage
Docs/pages/special-types/02-delegates.md Normalized ellipsis characters from ... to for consistency
Docs/pages/01-create-mocks.md Added comprehensive documentation for MockBehavior configuration options matching README updates

@vbreuss vbreuss enabled auto-merge (squash) January 31, 2026 11:40
@sonarqubecloud
Copy link

@github-actions
Copy link

Test Results

    21 files  ±0      21 suites  ±0   5m 13s ⏱️ +11s
 2 517 tests ±0   2 516 ✅ ±0  1 💤 ±0  0 ❌ ±0 
16 800 runs  ±0  16 799 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit 0f399be. ± Comparison against base commit 99e7c4b.

@vbreuss vbreuss merged commit 6937827 into main Jan 31, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/document-advanced-mockbehavior-options branch January 31, 2026 11:44
@github-actions
Copy link

github-actions bot commented Jan 31, 2026

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 3.13GHz, 1 CPU, 4 logical and 2 physical cores
.NET SDK 10.0.102
[Host] : .NET 10.0.2 (10.0.2, 10.0.225.61305), X64 RyuJIT x86-64-v3

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

Method Mean Error StdDev Gen0 Gen1 Allocated
Simple_Mockolate 1.614 μs 0.0112 μs 0.0105 μs 0.2270 - 3.73 KB
Simple_Moq 177.564 μs 1.8462 μs 1.7269 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.439 μs 0.0369 μs 0.0345 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.452 μs 0.0275 μs 0.0258 μs 0.4959 - 8.11 KB

@github-actions
Copy link

This is addressed in release v1.1.0.

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.

Document advanced mock behavior options

1 participant