Skip to content

Comments

docs: improve property and indexer setup documentation#443

Merged
vbreuss merged 4 commits intomainfrom
topic/document-property-indexer-setup
Jan 31, 2026
Merged

docs: improve property and indexer setup documentation#443
vbreuss merged 4 commits intomainfrom
topic/document-property-indexer-setup

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 31, 2026

This PR enhances the documentation for property and indexer setup in Mockolate by expanding examples and improving organization.

Key Changes:

  • Added documentation for advanced callback features including indexer parameters and current value access
  • Added examples for value-based returns using lambda expressions
  • Reorganized indexer documentation with clear sections and expanded examples

@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 13: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 enhances the documentation for property and indexer setup in Mockolate by expanding examples and improving organization.

Changes:

  • Added documentation for advanced callback features including invocation counters and current value access
  • Added examples for value-based returns using lambda expressions
  • Reorganized indexer documentation with clear sections and expanded examples

Reviewed changes

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

File Description
README.md Added comprehensive examples for property callbacks, value-based returns, and the Register method; reorganized indexer documentation with detailed sections
Docs/pages/setup/01-properties.md Added callback counter/value examples, sequence support, and Register section documentation
Docs/pages/setup/03-indexers.md Restructured into clear sections with expanded callback and return value examples

Copilot AI review requested due to automatic review settings January 31, 2026 13:13
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 6 comments.

@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 2.45GHz, 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.483 μs 0.0055 μs 0.0049 μs 0.2270 - 3.73 KB
Simple_Moq 175.694 μs 0.5755 μs 0.4806 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.425 μs 0.0226 μs 0.0200 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.132 μs 0.0177 μs 0.0157 μs 0.4959 - 8.11 KB

@github-actions
Copy link

github-actions bot commented Jan 31, 2026

Test Results

    21 files  ±0      21 suites  ±0   5m 46s ⏱️ -26s
 2 518 tests ±0   2 517 ✅ ±0  1 💤 ±0  0 ❌ ±0 
16 807 runs  ±0  16 806 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit f49b264. ± Comparison against base commit 5fb4b43.

♻️ This comment has been updated with latest results.

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

@vbreuss vbreuss merged commit fb7701e into main Jan 31, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/document-property-indexer-setup branch January 31, 2026 13:26
@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 property and indexer features

1 participant