Skip to content
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

Fixing XML documentation issues for Microsoft.AspNetCore.Http.Results' methods #44429

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Conversation

xakep139
Copy link
Contributor

@xakep139 xakep139 commented Oct 8, 2022

Fixing XML documentation issues for Microsoft.AspNetCore.Http.Results' methods

  • 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.

This PR fixes issues with the docs for Microsoft.AspNetCore.Http.Results' methods being incorrectly displayed.

Description

All these methods have incorrectly formed lists in their <summary> section, thus they are displayed with issues:

They all are also incorrectly displayed in https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.results?view=aspnetcore-6.0

This PR fixes all issues by following an official guide for the <list> tag of the XML Docs: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#list

Fixes #44428

@ghost ghost added area-runtime community-contribution Indicates that the PR has been added by a community member labels Oct 8, 2022
@ghost
Copy link

ghost commented Oct 8, 2022

Thanks for your PR, @xakep139. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@xakep139
Copy link
Contributor Author

xakep139 commented Oct 8, 2022

I haven't searched for other similar malformed lists, so there could be other such entries

Copy link
Member

@adityamandaleeka adityamandaleeka left a comment

Choose a reason for hiding this comment

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

Thanks @xakep139!

@adityamandaleeka
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@brunolins16
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@brunolins16 brunolins16 merged commit 678a06f into dotnet:main Oct 12, 2022
@ghost ghost added this to the 8.0-preview1 milestone Oct 12, 2022
@brunolins16
Copy link
Member

/backport to release/7.0

@ghost
Copy link

ghost commented Oct 12, 2022

Hi @brunolins16. It looks like you just commented on a closed PR. The team will most probably miss it. If you'd like to bring something important up to their attention, consider filing a new issue and add enough details to build context.

@github-actions
Copy link
Contributor

@xakep139 xakep139 deleted the patch-1 branch October 13, 2022 07:43
@amcasey amcasey added area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions and removed area-runtime labels Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Microsoft.AspNetCore.Http.Results' methods have invalid XML documentation
4 participants