Skip to content

docs: document advanced paramter matching features#431

Merged
vbreuss merged 2 commits into
mainfrom
topic/advanced-parameter-matching
Jan 31, 2026
Merged

docs: document advanced paramter matching features#431
vbreuss merged 2 commits into
mainfrom
topic/advanced-parameter-matching

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Jan 31, 2026

This PR reorganizes and expands the documentation for setup functionality by splitting a single setup document into multiple focused files and enhancing parameter matching documentation.

Key Changes:

  • Restructured setup documentation from a single file into separate topic files (properties, methods, indexers, parameter matching)
  • Enhanced parameter matching documentation with detailed examples for advanced features like regex, ref/out parameters, span parameters, and custom equality comparers
  • Updated README.md to reflect the reorganized structure and improved parameter matching documentation
  • Fix incorrect property/indexer callback syntax (missing .Do) in documentation

@vbreuss vbreuss self-assigned this Jan 31, 2026
Copilot AI review requested due to automatic review settings January 31, 2026 07:01
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 2026
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 reorganizes and expands the documentation for setup functionality by splitting a single setup document into multiple focused files and enhancing parameter matching documentation.

Changes:

  • Restructured setup documentation from a single file into separate topic files (properties, methods, indexers, parameter matching)
  • Enhanced parameter matching documentation with detailed examples for advanced features like regex, ref/out parameters, span parameters, and custom equality comparers
  • Updated README.md to reflect the reorganized structure and improved parameter matching documentation

Reviewed changes

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

Show a summary per file
File Description
README.md Updated setup section with reorganized content and expanded parameter matching documentation including detailed matcher examples
Mockolate.slnx Removed reference to old setup file and added references to new setup folder structure
Docs/pages/setup/category.json Added category configuration for new setup documentation folder
Docs/pages/setup/04-parameter-matching.md Created comprehensive parameter matching guide with detailed examples for all matcher types
Docs/pages/setup/03-indexers.md Created focused indexer setup documentation
Docs/pages/setup/02-methods.md Created focused method setup documentation
Docs/pages/setup/01-properties.md Created focused property setup documentation with incorrect callback syntax
Docs/pages/02-setup.md Removed old consolidated setup file

Comment thread README.md
Comment thread Docs/pages/setup/01-properties.md
Comment thread README.md
@github-actions
Copy link
Copy Markdown

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 2.66GHz, 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.552 μs 0.0109 μs 0.0097 μs 0.2270 - 3.73 KB
Simple_Moq 175.028 μs 0.3952 μs 0.3085 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.584 μs 0.0219 μs 0.0205 μs 0.5493 0.0076 9.09 KB
Simple_FakeItEasy 6.458 μs 0.0224 μs 0.0209 μs 0.4959 - 8.11 KB

@vbreuss vbreuss enabled auto-merge (squash) January 31, 2026 07:06
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

Test Results

    21 files  ±0      21 suites  ±0   5m 11s ⏱️ +2s
 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 5b42a5e. ± Comparison against base commit 56f1c38.

@vbreuss vbreuss merged commit 1bfc408 into main Jan 31, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/advanced-parameter-matching branch January 31, 2026 07:10
@github-actions
Copy link
Copy Markdown

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 parameter matching (ref/out/span parameters)

2 participants