Skip to content

docs: add documentation for delegates#428

Merged
vbreuss merged 4 commits intomainfrom
topic/document-delegates
Jan 30, 2026
Merged

docs: add documentation for delegates#428
vbreuss merged 4 commits intomainfrom
topic/document-delegates

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 30, 2026

This PR adds comprehensive documentation for mocking delegates in Mockolate. The documentation covers setup and verification of Action, Func<T>, and custom delegates, including those with ref and out parameters.

Changes:

  • Added new "Special Types" documentation section containing HttpClient and delegates
  • Reorganized documentation structure with new category files for "Special Types" and "Advanced Features"
  • Updated README.md to include delegate documentation inline

@vbreuss vbreuss self-assigned this Jan 30, 2026
Copilot AI review requested due to automatic review settings January 30, 2026 18:19
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 30, 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 adds comprehensive documentation for mocking delegates in Mockolate, addressing issue #413. The documentation covers setup and verification of Action, Func<T>, and custom delegates, including those with ref and out parameters.

Changes:

  • Added new "Special Types" documentation section containing HttpClient and delegates
  • Reorganized documentation structure with new category files for "Special Types" and "Advanced Features"
  • Updated README.md to include delegate documentation inline

Reviewed changes

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

Show a summary per file
File Description
README.md Added comprehensive delegates section under "Special Types" with setup and verification examples
Docs/pages/special-types/02-delegates.md New dedicated delegates documentation page with detailed examples
Docs/pages/special-types/01-httpclient.md Renamed from "Mocking HttpClient" to "HttpClient" for consistency
Docs/pages/special-types/category.json New category configuration for "Special Types" section at position 6
Docs/pages/advanced-features/category.json New category configuration for "Advanced Features" section at position 5
Mockolate.slnx Updated solution file structure to reflect new documentation organization

@vbreuss vbreuss enabled auto-merge (squash) January 30, 2026 18:23
@github-actions
Copy link

github-actions bot commented Jan 30, 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.573 μs 0.0245 μs 0.0229 μs 0.2270 - 3.73 KB
Simple_Moq 180.412 μs 0.8599 μs 0.8043 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.932 μs 0.0269 μs 0.0251 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.489 μs 0.0359 μs 0.0300 μs 0.4959 - 8.11 KB

Copilot AI review requested due to automatic review settings January 30, 2026 18:25
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

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

@sonarqubecloud
Copy link

@vbreuss vbreuss merged commit f51b285 into main Jan 30, 2026
11 checks passed
@vbreuss vbreuss deleted the topic/document-delegates branch January 30, 2026 18:34
@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 delegate mocking feature

2 participants