Skip to content

Clarify AllowUpdates property summary comment - #68618

Open
guardrex wants to merge 2 commits into
mainfrom
guardrex/allow-updates-description
Open

Clarify AllowUpdates property summary comment#68618
guardrex wants to merge 2 commits into
mainfrom
guardrex/allow-updates-description

Conversation

@guardrex

@guardrex guardrex commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Clarify AllowUpdates property summary comment

Updated summary comment for AllowUpdates property to clarify its behavior during enhanced navigation.

Description

Per @danroth27's suggestion on the docs issue ...

The PersistentStateAttribute.AllowUpdates API documentation currently says that the property controls whether a component receives updates "beyond the initial value provided during initialization." The Blazor prerendered-state documentation explains that this means updates supplied during enhanced navigation, but that scope isn't clear from the API text itself.

Suggested changes:

  • Update the API summary to mention enhanced-navigation updates explicitly.
  • ... pertains to article changes handled by a separate docs PR ...
  • ... pertains to article changes handled by a separate docs PR ...

Addresses dotnet/AspNetCore.Docs#37483

Updated summary comment for AllowUpdates property to clarify its behavior during enhanced navigation.
Copilot AI lite review requested due to automatic review settings August 18, 2026 11:07
@guardrex
guardrex requested a review from a team as a code owner August 18, 2026 11:07

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.

Pull request overview

Updates the API XML documentation for PersistentStateAttribute.AllowUpdates in Blazor Components to better convey that “beyond initial value” includes updates delivered during enhanced navigation, aligning the API surface documentation with the behavior described in the prerendered-state docs.

Changes:

  • Refines the AllowUpdates property <summary> text to explicitly mention enhanced navigation.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/Components/Components/src/PersistentStateAttribute.cs Outdated
Co-authored-by: guardrex <1622880+guardrex@users.noreply.github.com>
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.

3 participants