search

dotnet / aspnetcore

ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
https://asp.net
MIT License
35.2k stars 9.95k forks source link

More missing descriptions #17205

Closed vsfeedback closed 4 years ago

vsfeedback commented 4 years ago

This issue has been moved from a ticket on Developer Community.

The Configuration interface is missing a description as are the following classes:

Original Comments

Visual Studio Feedback System on 9/27/2019, 00:38 AM:

We have directed your feedback to the appropriate engineering team for further evaluation. The team will review the feedback and notify you about the next steps.

Visual Studio Feedback System on 9/27/2019, 01:32 AM:

Thank you for sharing your feedback! Our teams prioritize action on product issues with broad customer impact. See details at: https://docs.microsoft.com/en-us/visualstudio/ide/report-a-problem?view=vs-2017#faq. In case you need answers to common questions or need assisted support, be sure to use https://visualstudio.microsoft.com/vs/support/. We’ll keep you posted on any updates to this feedback.

Original Solutions

(no solutions)

javiercn commented 4 years ago

@halter73 Not sure if this is servers, but I'll let you folks deal with it.

Vasilisdm commented 4 years ago

I can work with that if the issue is still open.

halter73 commented 4 years ago

I don't know how the @vsfeedback bot works, but SocketsHttpHandler is in https://github.com/dotnet/corefx, so we might want @vsfeedback to open that issue there.

Also, do we typically provide class-level doc comments for extension method classes? These classes are typically never explicitly referenced, only the extension methods themselves. Not even WebHostBuilderExtensions has these.

I don't know what WebSocketAcceptControl is referring to.

javiercn commented 4 years ago

@halter73 This is typically a VSTS query that someone moved to GitHub for better tracking. If you open the ticket you can see who moved it.

Feel free to route this appropriately and close the issue. Maybe the VSTS issue needs to be moved to a different area.

@anurse or @mkArtakMSFT can probably help with that.

analogrelay commented 4 years ago

Also, do we typically provide class-level doc comments for extension method classes?

We should.

SocketsHttpHandler is in dotnet/corefx, so we might want @vsfeedback to open that issue there.

Covered by https://github.com/dotnet/dotnet-api-docs/issues/1551 already.

I don't know what WebSocketAcceptControl is referring to.

Agreed, I can't find that or what the original author was referring to by "Configuration".

Let's take this work item as adding class-level XML docs to:

@Vasilisdm if you're interested, feel free to submit a PR! XML doc updates are pretty easy, you just have to add the XML docs ;).

Vasilisdm commented 4 years ago

I will try and do that! Thanks for the update!

Maybe assign this issue to me?

analogrelay commented 4 years ago

Done! Looking forward to it!

Vasilisdm commented 4 years ago

Hello there! Thanks for the assign, I will try to address it the next few days.

halter73 commented 4 years ago

@Vasilisdm If you can do WebHostBuilderExtensions as part of this too, that'd be great. Thanks!

Vasilisdm commented 4 years ago

@halter73 I will try and do that.

I'll keep you posted!

Mika-net commented 4 years ago

@Vasilisdm are you still working on this? I'm looking for an issue to pick up.

Vasilisdm commented 4 years ago

@Mika-net feel free to grab it! I have not addressed it due to some unexpected issues i had not the time.

Mika-net commented 4 years ago

@Vasilisdm Thanks! Hope you are alright brother.