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.55k stars 10.05k forks source link

More API docs #27538

Closed JunTaoLuo closed 2 years ago

JunTaoLuo commented 4 years ago

Looks like there are more API docs that need to be added for the following:

JunTaoLuo commented 4 years ago

We'll need to divide this up fyi @pranavkm

dougbu commented 4 years ago

@JunTaoLuo please check if dotnet/aspnetcore#27285 already lists the problem areas you mentioned above. If not, please mention this issue in the description.

JunTaoLuo commented 3 years ago

Hey folks. I took a look at the rest of the projects missing API docs and divided up the work. I've tried to assign folks with areas they are familiar with but let me know if they need to be reassigned.

ghost commented 3 years ago

Thanks for contacting us. We're moving this issue to the Next sprint planning milestone for future evaluation / consideration. We will evaluate the request when we are planning the work for the next milestone. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

sebastienros commented 3 years ago

I checked the remaining boxes to be ticked and couldn't find any namespace without doc. Can someone validate?

BrennanConroy commented 3 years ago

We want to remove most of the CS1591 warning skips, there are still a few left (Kestrel has some) https://github.com/dotnet/aspnetcore/search?q=CS1591

ghost commented 2 years ago

Thanks for contacting us.

We're moving this issue to the .NET 7 Planning milestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s). If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

wtgodbe commented 2 years ago

@SteveSandersonMS @TanayParikh @pranavkm @halter73 looks like there are still some missing doc comments for JsonPatch, Razor, and Connections.Abstractions. I removed the other CS1591s in https://github.com/dotnet/aspnetcore/pull/40104

wtgodbe commented 2 years ago

Actually all of the CS1591's are still active, there are a bunch of doc comments to add in Kestrel too.