Skip to content

refactor: remove unnecessary newlines within XML documentation of generated code#384

Merged
vbreuss merged 1 commit into
mainfrom
topic/remove-unnecessary-newlines-in-sourcegenerated-code
Jan 23, 2026
Merged

refactor: remove unnecessary newlines within XML documentation of generated code#384
vbreuss merged 1 commit into
mainfrom
topic/remove-unnecessary-newlines-in-sourcegenerated-code

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Jan 23, 2026

This PR refactors the source generator code to remove unnecessary newlines within XML documentation comments of generated code. The changes improve the formatting and readability of the generated documentation.

Key Changes:

  • Removed extra AppendLine() calls that created blank lines within XML documentation comments
  • Fixed a typo in parameter documentation (changed double period ".." to single period ".")

@vbreuss vbreuss self-assigned this Jan 23, 2026
Copilot AI review requested due to automatic review settings January 23, 2026 15:18
@vbreuss vbreuss changed the title refactor: remove unnecessary newlines within XML documentation of gen… refactor: remove unnecessary newlines within XML documentation of generated code Jan 23, 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 refactors the source generator code to remove unnecessary newlines within XML documentation comments of generated code. The changes improve the formatting and readability of the generated documentation.

Changes:

  • Removed extra AppendLine() calls that created blank lines within XML documentation comments
  • Fixed a typo in parameter documentation (changed double period ".." to single period ".")

@vbreuss vbreuss enabled auto-merge (squash) January 23, 2026 15:19
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

Test Results

    14 files  ±0      14 suites  ±0   5m 41s ⏱️ -44s
 2 301 tests ±0   2 300 ✅ ±0  1 💤 ±0  0 ❌ ±0 
15 412 runs  ±0  15 411 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit a5aebcc. ± Comparison against base commit e486de5.

@vbreuss vbreuss merged commit 1f5a930 into main Jan 23, 2026
12 checks passed
@vbreuss vbreuss deleted the topic/remove-unnecessary-newlines-in-sourcegenerated-code branch January 23, 2026 15:24
@github-actions
Copy link
Copy Markdown

🚀 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.543 μs 0.0138 μs 0.0116 μs 0.2270 - 3.73 KB
Simple_Moq 180.246 μs 0.9724 μs 0.9096 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.984 μs 0.0706 μs 0.0626 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.537 μs 0.0162 μs 0.0135 μs 0.4959 - 8.11 KB

@github-actions
Copy link
Copy Markdown

This is addressed in release v1.0.1.

@github-actions github-actions Bot added the state: released The issue is released label Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants