Skip to content

Add doc strings for public APIs in Http.Abstractions and Routing.Abstractions #26468

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 3 commits into from
Sep 30, 2020

Conversation

captainsafia
Copy link
Member

Part of #26397.

@captainsafia captainsafia force-pushed the safia/http-abstract-docs branch from 1491840 to 4e8f212 Compare September 30, 2020 18:53
@@ -8,23 +8,45 @@

namespace Microsoft.AspNetCore.Http
{
/// <summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

Shoot: #26358. I had some of these documented in an earlier pass. I should have clarified it in the docs

public static class StatusCodes
{
/// <summary>
/// HTTP status code 100.
/// </summary>
public const int Status100Continue = 100;
Copy link
Contributor

Choose a reason for hiding this comment

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

Good grief. I gave up when I got to this type

Copy link
Member Author

Choose a reason for hiding this comment

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

A little patience and a whole lotta Cmd+V 😝 .

@@ -13,7 +16,7 @@ public class LinkOptions

/// <summary>
/// Gets or sets a value indicating whether a generated query strings are lowercase.
/// This property will be unless <see cref="LowercaseUrls" /> is also <c>true</c>.
/// This property will be false unless <see cref="LowercaseUrls" /> is also <c>true</c>.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@JamesNK JamesNK added this to the 5.0.0 milestone Sep 30, 2020
@ajaybhargavb ajaybhargavb added the tell-mode Indicates a PR which is being merged during tell-mode label Sep 30, 2020
@ajaybhargavb ajaybhargavb merged commit e2b1b20 into release/5.0 Sep 30, 2020
@ajaybhargavb ajaybhargavb deleted the safia/http-abstract-docs branch September 30, 2020 20:50
@@ -3,77 +3,338 @@

namespace Microsoft.AspNetCore.Http
{
// Status Codes listed at http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
/// <summary>
/// A collection of contants for HTTP status codes.
Copy link
Member

Choose a reason for hiding this comment

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

constants

Copy link
Member Author

Choose a reason for hiding this comment

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

Oof. I'll fix this in my other PR.

@amcasey amcasey added area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions and removed area-runtime labels Aug 24, 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 tell-mode Indicates a PR which is being merged during tell-mode
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants