Skip to content

docs: improve method setup documentation#446

Merged
vbreuss merged 3 commits intomainfrom
topic/improve-method-documentation
Jan 31, 2026
Merged

docs: improve method setup documentation#446
vbreuss merged 3 commits intomainfrom
topic/improve-method-documentation

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 31, 2026

This PR reorganizes the method setup documentation to improve clarity and readability by grouping related concepts together and providing better structure.

Key Changes:

  • Restructured method setup documentation into logical subsections (Returns/Throws, Async Methods, Callbacks)
  • Moved callback-related content to a dedicated section
  • Added a note about .SkippingBaseClass(…) to property documentation

@vbreuss vbreuss self-assigned this Jan 31, 2026
Copilot AI review requested due to automatic review settings January 31, 2026 19:48
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 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 reorganizes the method setup documentation to improve clarity and readability by grouping related concepts together and providing better structure.

Changes:

  • Restructured method setup documentation into logical subsections (Returns/Throws, Async Methods, Callbacks)
  • Moved callback-related content to a dedicated section
  • Added a note about .SkippingBaseClass(…) to property documentation

Reviewed changes

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

File Description
README.md Reorganized method setup section with new subsections and moved examples to appropriate locations
Docs/pages/setup/02-methods.md Applied same documentation restructuring as README.md with improved section hierarchy
Docs/pages/setup/01-properties.md Added note about .SkippingBaseClass(…) for consistency with method documentation

@vbreuss vbreuss force-pushed the topic/improve-method-documentation branch from 0bfa37a to 3d91b56 Compare January 31, 2026 19:50
Copilot AI review requested due to automatic review settings January 31, 2026 19:51
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 1 comment.

@vbreuss vbreuss enabled auto-merge (squash) January 31, 2026 19:52
@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.62GHz, 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.533 μs 0.0047 μs 0.0042 μs 0.2270 - 3.73 KB
Simple_Moq 179.075 μs 0.9353 μs 0.8291 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.563 μs 0.0140 μs 0.0131 μs 0.5493 0.0076 9.09 KB
Simple_FakeItEasy 6.367 μs 0.0100 μs 0.0083 μs 0.4959 - 8.11 KB

@sonarqubecloud
Copy link

@github-actions
Copy link

Test Results

    21 files  ±0      21 suites  ±0   5m 18s ⏱️ +9s
 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 a7653ac. ± Comparison against base commit 193ebe8.

@vbreuss vbreuss merged commit 2852edd into main Jan 31, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/improve-method-documentation branch January 31, 2026 19:57
@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