Skip to content
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

Removed duplicate examples from the SqlServerServiceCollectionExtensions #30

Closed
wants to merge 1 commit into from
Closed

Conversation

tidusjar
Copy link

@tidusjar tidusjar commented Nov 5, 2018

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.

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
Copy link
Contributor

divega commented Nov 9, 2018

@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
Copy link
Contributor

divega commented Nov 12, 2018

@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
Copy link
Contributor

divega commented Nov 12, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants