Skip to content

Fixed documentation for Kestrel ListenOptions.Protocols #57280

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from Aug 12, 2024
Merged

Fixed documentation for Kestrel ListenOptions.Protocols #57280

merged 1 commit into from Aug 12, 2024

Conversation

ghost
Copy link

@ghost ghost commented Aug 12, 2024 •
edited by ghost
Loading

Fixed documentation for Kestrel ListenOptions.Protocols

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Corrected the documentation of the Protocols property in the Kestrel Listen Options.

Description

The default protocols for Kestrel were changed with PR #50243. The corresponding documentation was not adapted. This was corrected to represent the actual default value.

aspnetcore/src/Servers/Kestrel/Core/src/ListenOptions.cs

Line 19 in e964765

internal const HttpProtocols DefaultHttpProtocols = HttpProtocols.Http1AndHttp2;

Fixes #57279

@ghost ghost added the area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions label Aug 12, 2024
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Aug 12, 2024
amcasey
amcasey approved these changes Aug 12, 2024
View reviewed changes
Copy link
Member

@amcasey amcasey left a comment

Choose a reason for hiding this comment

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

Good catch! Thanks!

@amcasey amcasey merged commit 19a66f1 into dotnet:main Aug 12, 2024
26 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 9.0-rc1 milestone Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@halter73 halter73 Awaiting requested review from halter73 halter73 is a code owner

@BrennanConroy BrennanConroy Awaiting requested review from BrennanConroy BrennanConroy is a code owner

@JamesNK JamesNK Awaiting requested review from JamesNK JamesNK is a code owner

@mgravell mgravell Awaiting requested review from mgravell mgravell is a code owner

Assignees
No one assigned
Labels
area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Milestone
9.0-rc1
Development

Successfully merging this pull request may close these issues.

Documentation for Kestrel ListenOptions.Protocol is incorrect
1 participant
@amcasey