Skip to content

Reword HostAbortedException docs #113336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2025

Conversation

ericstj
Copy link
Member

@ericstj ericstj commented Mar 10, 2025

See #60600 or #69404 for reference.

@carlossanlop - should I port this to dotnet-api-docs manually after merging, or will our process do that?

@Copilot Copilot AI review requested due to automatic review settings March 10, 2025 18:30
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR rewords the documentation for HostAbortedException to clarify its intended usage.

  • Updated the summary description to indicate that the exception is thrown when an IHost stops gracefully and should not be thrown or caught by user code.

Reviewed Changes

File Description
src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostAbortedException.cs Updated the exception documentation to better reflect its usage

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

Comments suppressed due to low confidence (1)

src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/HostAbortedException.cs:9

  • The updated documentation refers to the host being 'stopped gracefully', which may conflict with the exception name 'HostAbortedException'. Consider aligning the terminology to avoid potential confusion—either adjust the name or update the wording to better match the intended behavior.
/// The exception that is thrown when an <see cref="IHost"/> is stopped to indicate the Host is stopping gracefully.  This exception should not be thrown or handled by user code.

@carlossanlop
Copy link
Member

should I port this to dotnet-api-docs manually after merging, or will our process do that?

Microsoft.Extensions.Hosting uses triple slash as source of truth, so you don't need to do anything else. This update will get propagated automatically to the docs repo.

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

I think this looks good as a description of the exception type itself.

@tarekgh tarekgh added this to the 10.0.0 milestone Mar 10, 2025
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Member

@eerhardt eerhardt left a comment

Choose a reason for hiding this comment

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

👍

@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants