Update API docs to conform with doc standards

dotnet / efcore

EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations.

https://docs.microsoft.com/ef/

MIT License

13.79k stars 3.19k forks source link

Update API docs to conform with doc standards #22893

Open AbandonedRickshaw opened 4 years ago

AbandonedRickshaw commented 4 years ago

It's just a generated stub, with no references to methods, properties, etc.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ID: 1004d955-1180-5aed-be4c-a071c060a745
Version Independent ID: 8f897a0e-b4fa-5d5e-009f-9fdc91793473
Content: DbContext.Database Property (Microsoft.EntityFrameworkCore)
Content Source: dotnet/xml/Microsoft.EntityFrameworkCore/DbContext.xml
Product: entity-framework-core
GitHub Login: @dotnet-bot
Microsoft Alias: divega

roji commented 4 years ago

This property has already been documented for 5.0 (along with many others), but the updated docs will only be visible when 5.0 is released.

smitpatel commented 4 years ago

Missing value tags in XML docs.

roji commented 4 years ago

We hardly have value tags anywhere in our docs (seems like 12 occurrences in the core project, I've personally never understood why those are needed in addition to the summary). If we think it's important, maybe open a separate issue for a larger effort?

smitpatel commented 4 years ago

We discussed this issue in triage briefly and determined that we should do something to avoid empty "Property Value" on the doc page. Adding value tag resolves that. The task item in triage was to figure out API docs guidelines from docs team, which I sent in an email. We will discuss this in next meeting.