[docs] Update custom-resource-commands to use new CommandResults.Success displayImmediately overload#897
Merged
davidfowl merged 1 commit intoMay 11, 2026
Conversation
…ss displayImmediately overload Update the 'Auto-open the result dialog in the dashboard' C# example to use the new four-argument CommandResults.Success overload added in microsoft/aspire#16906, replacing the lower-level CommandResultData object-initializer pattern with the more ergonomic factory call. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
davidfowl
deleted the
docs/add-displayimmediately-overload-cd4c3e4294eca964
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#16906 by
@davidfowl.Targeting
mainbecauserelease/13.4does not yet exist onmicrosoft/aspire.dev(milestone on the source PR is13.4).Why this PR is needed
PR #16906 adds a new
CommandResults.Success(message, result, resultFormat, displayImmediately)overload to make theDisplayImmediatelyflag discoverable directly from the factory method, without requiring developers to construct aCommandResultDataobject manually.The existing docs in
fundamentals/custom-resource-commands.mdxshowed the lower-level object-initializer pattern for settingDisplayImmediately. The updated example uses the new, simpler four-argument overload.What changed
src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx: The C# code example in the "Auto-open the result dialog in the dashboard" section now usesCommandResults.Success(message, result, resultFormat, displayImmediately: true)instead of thevalue: new CommandResultData { ... }object-initializer form.