Skip to content

docs: explain how to use Primitives alongside System.Reactive - #226

Merged
glennawatson merged 1 commit into
mainfrom
docs/system-reactive-coexistence
Sep 24, 2026
Merged

glennawatson merged 1 commit into
mainfrom
docs/system-reactive-coexistence

Conversation

@glennawatson

Copy link
Copy Markdown
Contributor

Summary

The README now explains how to use ReactiveUI.Primitives in a project where another package still brings in System.Reactive.

  • New section "Using both libraries in one project" under "Moving from System.Reactive". It lists three fixes for the ambiguous Subscribe call (error CS0121): an alias on the System.Reactive package reference for the whole project, a using directive inside the namespace for one file, and SubscribePrimitives for one call.
  • The note near the top of the README now links to that section instead of naming only SubscribePrimitives.

Why

Users who add ReactiveUI.Primitives next to a package that depends on System.Reactive hit CS0121 on every Subscribe call.

Breaking changes

None. Documentation only.

How this was verified

Every snippet in the new section compiles against the current build in a project that references System.Reactive.

  • That includes plain .Subscribe(...) calls resolving to ReactiveUI.Primitives once the alias is in place.

Notes for the reviewer

The whole change is in README.md.

  • The section sits under the migration guide, since the repository rules keep System.Reactive references under the comparison and migration headers.

Checklist

  • I have read the Contribute guide
  • The PR title follows Conventional Commits
  • Tests cover this change, or the summary says why they do not
  • New or changed public API has XML documentation

Add a section under the System.Reactive migration guide for projects where
another package still brings in System.Reactive, so Subscribe is ambiguous.
It covers three fixes: an alias on the System.Reactive package reference,
a using directive inside the namespace, and SubscribePrimitives. The note
near the top of the README now links to it.
@glennawatson
glennawatson merged commit f68fe17 into main Sep 24, 2026
10 checks passed
@glennawatson
glennawatson deleted the docs/system-reactive-coexistence branch September 24, 2026 06:46
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Sep 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.78%. Comparing base (2a8b66d) to head (fe3c282).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #226   +/-   ##
=======================================
  Coverage   99.78%   99.78%           
=======================================
  Files         785      785           
  Lines       24850    24850           
  Branches     2946     2946           
=======================================
  Hits        24796    24796           
  Misses         54       54           

☔ View full report in Codecov by Harness.
📢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant