Skip to content

Comments

docs: document Between and Times verification methods#438

Merged
vbreuss merged 2 commits intomainfrom
topic/document-verification-count-methods
Jan 31, 2026
Merged

docs: document Between and Times verification methods#438
vbreuss merged 2 commits intomainfrom
topic/document-verification-count-methods

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 31, 2026

This PR documents two previously undocumented verification methods (Between and Times) in the Mockolate library's verification API. The changes enhance the documentation by adding descriptions to all verification methods and providing usage examples for the newly documented methods.

Key Changes:

  • Added descriptions to all verification method list items to clarify their behavior
  • Documented the Between(min, max) method for verifying interactions within a range
  • Documented the Times(predicate) method for custom verification predicates
  • Reformatted existing code examples for improved readability
  • Added practical examples demonstrating the use of Between and Times methods

@vbreuss vbreuss self-assigned this Jan 31, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 2026
Copilot AI review requested due to automatic review settings January 31, 2026 11:22
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 documents two previously undocumented verification methods (Between and Times) in the Mockolate library's verification API. The changes enhance the documentation by adding descriptions to all verification methods and providing usage examples for the newly documented methods.

Changes:

  • Added descriptions to all verification method list items to clarify their behavior
  • Documented the Between(min, max) method for verifying interactions within a range
  • Documented the Times(predicate) method for custom verification predicates
  • Reformatted existing code examples for improved readability
  • Added practical examples demonstrating the use of Between and Times methods

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Added descriptions to verification methods list, documented Between and Times methods, and added usage examples
Docs/pages/04-verify-interactions.md Mirror of README.md changes - added method descriptions and examples for Between and Times verification methods

@vbreuss vbreuss enabled auto-merge (squash) January 31, 2026 11:25
@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.24GHz, 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.498 μs 0.0117 μs 0.0103 μs 0.2270 - 3.73 KB
Simple_Moq 175.944 μs 0.8993 μs 0.7972 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.552 μs 0.0234 μs 0.0207 μs 0.5493 0.0076 9.09 KB
Simple_FakeItEasy 6.368 μs 0.0903 μs 0.0844 μs 0.4959 - 8.11 KB

@sonarqubecloud
Copy link

@github-actions
Copy link

Test Results

    21 files  ±0      21 suites  ±0   4m 34s ⏱️ - 1m 17s
 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 886676b. ± Comparison against base commit 182ec01.

@vbreuss vbreuss merged commit 99e7c4b into main Jan 31, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/document-verification-count-methods branch January 31, 2026 11:31
@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 additional verification count methods

2 participants