Improve XML documentation comments

[mitchdenny]

Enhance clarity and detail in XML documentation comments for resource health checks and wait behaviors.

[Copilot]

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs:235

• There is an inconsistency in the terminology used in documentation. In this method the term 'terminal state' is used, whereas in the related overload documentation another file refers to 'unhealthy terminal state'. Consider standardizing the phrasing for clarity.

/// If the resource enters a terminal state such as <see cref="KnownResourceStates.FailedToStart"/> then

src/Aspire.Hosting/ResourceBuilderExtensions.cs:737

• The XML comment here uses 'unhealthy terminal state' while similar documentation in ResourceNotificationService.cs uses 'terminal state'. Aligning the language across methods would improve consistency.

/// will throw a <see cref="DistributedApplicationException"/> if the resource enters an unhealthy terminal state.

[JamesNK]

terminal -> unavailable

I think this is better because the enum option uses the word "Unavailable" and that's more accurate because logic includes some non terminal states.

[eerhardt]

Suggested change

	/// then the method will continue to wait until the resource reaches a <see cref="KnownResourceStates.Running"/> state. This is the default
	/// behavior with the <see cref="WaitForResourceHealthyAsync(string, CancellationToken)"/> overload.
	/// then the method will continue to wait until the resource reaches a <see cref="KnownResourceStates.Running"/> state.

I would remove this sentence since:

1. It is about a different method than what we are documenting here.
2. It isn't accurate since the ResourceNotificationServiceOptions.DefaultWaitBehavior can (and will) change the behavior of that method.

[eerhardt]

LGTM. Thanks!

[mitchdenny]

/backport to release/9.1

[github-actions]

Started backporting to release/9.1: https://github.com/dotnet/aspire/actions/runs/13466532044