search

dotnet / EntityFramework.ApiDocs

Reference documentation for Entity Framework APIs
Creative Commons Attribution 4.0 International
17 stars 44 forks source link

Removed duplicate examples from the SqlServerServiceCollectionExtensions #30

Closed tidusjar closed 6 years ago

tidusjar commented 6 years ago

We had the same example duplicated a few times, I have now removed this and we are back to 1 example that is no longer duplicated.

divega commented 6 years ago

@tidusjar thanks! Could you please send a PR to change these xml comments in the product code in the EntityFrameworkCore repo? Changes made here are overwritten when the API docs are regenerated.

divega commented 6 years ago

@tidusjar I am actually not seeing this problem in the product source code, even on the release/2.1 branch, which should be an exact copy of the source used to produce the 2.1.0 version of the NuGet package.

I think this may be product of a bug somewhere in the tooling that extracts the XML documentation.

@dend is there any known issue around this? Otherwise, what would be the right place to report it?

Maybe something that causes the <example> attribute to be repeated two or three times? I see the same repetition in other similar classes like https://github.com/aspnet/EntityFramework.ApiDocs/blob/master/dotnet/xml/Microsoft.Extensions.DependencyInjection/InMemoryServiceCollectionExtensions.xml, https://github.com/aspnet/EntityFramework.ApiDocs/blob/master/dotnet/xml/Microsoft.Extensions.DependencyInjection/SqliteServiceCollectionExtensions.xml.

divega commented 6 years ago

Closing this PR as I don't think taking it would have the desired effect. I have created #33 for now to track the bug in the API docs pipeline. I hope @dend can help us find a better place for it.