Pomelo.entityframeworkcore.mysql: XML documentation is not included in the package
Steps to reproduce
Add a reference to the package to a project in an IDE that supports viewing XML documentation, for example, Visual Studio. Use any types of methods provided by the package.
The issue
No XML documentation is available when using this package. This issue costs developers a lot of time trying to figure out how to use the package's public APIs.
Please include the XML documentation files together with the assemblies in the package.
hainguyenthanh
All 3 comments
@hainguyenthanh Looks fine when I try it:
Visual Studio 2019, 16.8.2
Rider 2020.3 EAP 8
Also, the package itself _does_ contain the necessary XML docs file:
So to find out where the issue is, we have to investigate a bit further:
- For what method do you expect there to be XML documentation available?
- What IDE are you using?
It might also be helpful, if you can share your project/solution with us.
lauxjpn
on 25 Nov 2020
@lauxjpn I'm using the stable version 3.2.4 and it seems that the XML documentation is not included in this version. The 5.0.0 alpha 2 version does include documentation.
hainguyenthanh
on 25 Nov 2020
@hainguyenthanh Ah, that is correct, we included the XML docs in the major 5.0 upgrade.
I'll add the docs to the 3.2-maint branch as well.
lauxjpn
on 25 Nov 2020
Related issues
guaicaiboshi
·
4Comments
IonRobu
·
3Comments
coultonluke
·
3Comments
cetubig
·
3Comments
matthewjcooper
·
4Comments
Most helpful comment
@hainguyenthanh Ah, that is correct, we included the XML docs in the major 5.0 upgrade.
I'll add the docs to the 3.2-maint branch as well.