Skip to content

Document EXTOBS0003: HybridCacheOptions.DisableCompression is obsolete - #56636

Merged
BillWagner merged 3 commits into
dotnet:mainfrom
svick:document-extobs0003
Oct 30, 2026
Merged

BillWagner merged 3 commits into
dotnet:mainfrom
svick:document-extobs0003

Conversation

@svick

@svick svick commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Summary

Document warning EXTOBS0003 for the obsolete HybridCacheOptions.DisableCompression property, and add the page to the obsoletion index and diagnostics TOC.

Related to dotnet/extensions#7885.

Content source breakdown:

  • Warning and rationale: adapted from the Obsolete attribute, diagnostic message, and property remarks in Mark HybridCacheOptions.DisableCompression as obsolete extensions#7885.
  • Workarounds: adapted from the property's remarks and the PR's explanation that HybridCacheEntryFlags.DisableCompression remains unchanged. Link to the existing custom serialization documentation.
  • Warning suppression: newly generated wording based on the existing obsoletion documentation, with a link to the shared suppression instructions.
  • Index and TOC entries: newly generated navigation updates.

No content was copied verbatim. The article is AI-generated and requires expert review. No package version is asserted because the source PR doesn't identify the first released package that contains the warning.

Validation:

  • npx --yes markdownlint-cli2 docs\fundamentals\syslib-diagnostics\extobs0003.md docs\fundamentals\syslib-diagnostics\obsoletions-overview.md — passed, zero issues.
  • No executable code samples were added.

Note

This PR and its documentation were generated with GitHub Copilot.


Internal previews

File Preview link
docs/fundamentals/syslib-diagnostics/extobs0003.md Learn preview
docs/fundamentals/syslib-diagnostics/obsoletions-overview.md Learn preview
docs/navigate/tools-diagnostics/toc.yml Learn preview

Build report

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7acdfec6-bcbc-4332-a81f-de770b55241b
Copilot AI balanced review requested due to automatic review settings October 29, 2026 18:21
@dotnetrepoman dotnetrepoman Bot added this to the October 2026 milestone Oct 29, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The documentation link uses the incorrect fragment #hybridcache and must use #hybrid-caching to navigate to the intended section.

1 open issue
What changed in this PR

This PR documents warning EXTOBS0003 for the obsolete HybridCacheOptions.DisableCompression property and integrates the article into the diagnostic documentation.

Changes:

  • Explain why the property has no effect, how to remove its use, and how to suppress the warning.
  • Add the diagnostic to the obsoletion index and navigation.
File Description
docs/​navigate/​tools-diagnostics/​toc.yml Add the EXTOBS0003 navigation entry.
docs/​fundamentals/​syslib-diagnostics/​obsoletions-overview.md Add EXTOBS0003 to the obsoletion index.
docs/​fundamentals/​syslib-diagnostics/​extobs0003.md Document the warning, workarounds, and suppression options.

Review effort: Balanced

svick and others added 2 commits October 29, 2026 19:25
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7acdfec6-bcbc-4332-a81f-de770b55241b
Moved and clarified the status of HybridCacheEntryFlags.DisableCompression.
@svick
svick requested a balanced review from Copilot October 30, 2026 10:59
@svick
svick marked this pull request as ready for review October 30, 2026 10:59
@svick
svick requested a review from BillWagner as a code owner October 30, 2026 10:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the EXTOBS0003 documentation update.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@BillWagner BillWagner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, and I'll :shipit: now.

@BillWagner
BillWagner merged commit 7dade33 into dotnet:main Oct 30, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants