Skip to content

docs: improve documentation#451

Merged
vbreuss merged 6 commits intomainfrom
topic/improve-documentation-2
Feb 1, 2026
Merged

docs: improve documentation#451
vbreuss merged 6 commits intomainfrom
topic/improve-documentation-2

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Feb 1, 2026

This PR improves documentation clarity and consistency across README.md and the create-mocks documentation page by reorganizing content, clarifying explanations, and fixing examples.

Key Changes:

  • Reorganized MockBehavior options documentation to improve readability
  • Updated code examples to use MockBehavior.Default with { ... } syntax instead of new MockBehavior { ... }
  • Added clarifying notes about wrapping instances and additional interfaces

@vbreuss vbreuss self-assigned this Feb 1, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Feb 1, 2026
@github-actions
Copy link

github-actions bot commented Feb 1, 2026

Test Results

    21 files  ±0      21 suites  ±0   5m 37s ⏱️ +3s
 2 508 tests ±0   2 507 ✅ ±0  1 💤 ±0  0 ❌ ±0 
16 835 runs  ±0  16 834 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit e1cbe0b. ± Comparison against base commit 2097b4d.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Feb 1, 2026

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.63GHz, 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.539 μs 0.0202 μs 0.0179 μs 0.2270 - 3.73 KB
Simple_Moq 176.112 μs 0.8483 μs 0.7520 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.642 μs 0.0774 μs 0.0686 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.582 μs 0.0445 μs 0.0416 μs 0.4959 - 8.11 KB

@vbreuss vbreuss marked this pull request as ready for review February 1, 2026 08:09
Copilot AI review requested due to automatic review settings February 1, 2026 08:09
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 improves documentation clarity and consistency across README.md and the create-mocks documentation page by reorganizing content, clarifying explanations, and fixing examples.

Changes:

  • Reorganized MockBehavior options documentation to improve readability
  • Updated code examples to use MockBehavior.Default with { ... } syntax instead of new MockBehavior { ... }
  • Added clarifying notes about wrapping instances and additional interfaces

Reviewed changes

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

File Description
README.md Reorganized MockBehavior options, updated examples to use with syntax, added clarifications for mocking multiple interfaces and wrapping instances
Docs/pages/01-create-mocks.md Applied identical documentation improvements as README.md for consistency

Copilot AI review requested due to automatic review settings February 1, 2026 08:14
@vbreuss vbreuss force-pushed the topic/improve-documentation-2 branch from 03737c9 to 1d9f6ef Compare February 1, 2026 08:14
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 2 out of 2 changed files in this pull request and generated no new comments.

@vbreuss vbreuss enabled auto-merge (squash) February 1, 2026 08:15
@vbreuss vbreuss disabled auto-merge February 1, 2026 08:17
Copilot AI review requested due to automatic review settings February 1, 2026 08:31
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 3 out of 3 changed files in this pull request and generated no new comments.

@vbreuss vbreuss force-pushed the topic/improve-documentation-2 branch from 27e71e6 to 30b1d39 Compare February 1, 2026 08:32
Copilot AI review requested due to automatic review settings February 1, 2026 08:33
@vbreuss vbreuss force-pushed the topic/improve-documentation-2 branch from 30b1d39 to f374f88 Compare February 1, 2026 08:33
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 3 out of 3 changed files in this pull request and generated no new comments.

@vbreuss vbreuss enabled auto-merge (squash) February 1, 2026 08:35
@vbreuss vbreuss disabled auto-merge February 1, 2026 08:36
@vbreuss vbreuss enabled auto-merge (squash) February 1, 2026 08:37
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 1, 2026

@vbreuss vbreuss merged commit 11bf57a into main Feb 1, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/improve-documentation-2 branch February 1, 2026 08:42
@github-actions
Copy link

github-actions bot commented Feb 1, 2026

This is addressed in release v1.2.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.

2 participants