Skip to content

fix(docs): Remove obsolete upgrade notes from interceptor XML docs#100

Merged
samtrion merged 1 commit intomainfrom
fix/incorrect-docs
Mar 26, 2026
Merged

fix(docs): Remove obsolete upgrade notes from interceptor XML docs#100
samtrion merged 1 commit intomainfrom
fix/incorrect-docs

Conversation

@samtrion
Copy link
Contributor

@samtrion samtrion commented Mar 26, 2026

Removed "Upgrade Notes" sections from IEventInterceptor.cs and IRequestInterceptor.cs XML documentation. These notes about previous breaking changes to handler delegate signatures are no longer relevant. All other documentation remains intact.

Summary by CodeRabbit

  • Documentation
    • Removed upgrade notes from event and request interceptor interfaces.

Removed "Upgrade Notes" sections from IEventInterceptor.cs and IRequestInterceptor.cs XML documentation. These notes about previous breaking changes to handler delegate signatures are no longer relevant. All other documentation remains intact.
@samtrion samtrion self-assigned this Mar 26, 2026
@samtrion samtrion requested a review from a team as a code owner March 26, 2026 16:19
@samtrion samtrion requested a review from Hnogared March 26, 2026 16:19
@samtrion samtrion added state:ready for merge Indicates that a pull request has been reviewed and approved, and is ready to be merged into the mai type:bug Indicates an issue or flaw that needs to be fixed. labels Mar 26, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 94dcfc68-2d7d-43e5-a5a6-2e2e04f2aba6

📥 Commits

Reviewing files that changed from the base of the PR and between 4c62f82 and dff6d09.

📒 Files selected for processing (2)
  • src/NetEvolve.Pulse.Extensibility/IEventInterceptor.cs
  • src/NetEvolve.Pulse.Extensibility/IRequestInterceptor.cs
💤 Files with no reviewable changes (2)
  • src/NetEvolve.Pulse.Extensibility/IEventInterceptor.cs
  • src/NetEvolve.Pulse.Extensibility/IRequestInterceptor.cs

Walkthrough

This change removes XML documentation "Upgrade Notes" sections from two interceptor interfaces in the extensibility namespace. The removed documentation described breaking changes to delegate signatures where CancellationToken parameters were added. Interface method signatures and implementations remain unaffected.

Changes

Cohort / File(s) Summary
Interceptor Interface Documentation
src/NetEvolve.Pulse.Extensibility/IEventInterceptor.cs, src/NetEvolve.Pulse.Extensibility/IRequestInterceptor.cs
Removed XML documentation "Upgrade Notes" sections describing breaking changes to handler delegate signatures and required invocation patterns. No code or method signature modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through docs with glee, 🐰
Tidying notes from history,
The upgrade warnings fade away,
While code lives strong another day! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: removing obsolete upgrade notes from XML documentation in interceptor files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.00%. Comparing base (c6a4d23) to head (dff6d09).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #100   +/-   ##
=======================================
  Coverage   85.00%   85.00%           
=======================================
  Files          42       42           
  Lines        1307     1307           
  Branches      118      118           
=======================================
  Hits         1111     1111           
  Misses        157      157           
  Partials       39       39           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@samtrion samtrion merged commit 798a89f into main Mar 26, 2026
12 checks passed
@samtrion samtrion deleted the fix/incorrect-docs branch March 26, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

state:ready for merge Indicates that a pull request has been reviewed and approved, and is ready to be merged into the mai type:bug Indicates an issue or flaw that needs to be fixed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant