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

NpgsqlConnection docs are missing most methods #101

Closed
loop-evgeny opened this issue Apr 16, 2021 · 2 comments
Closed

NpgsqlConnection docs are missing most methods #101

loop-evgeny opened this issue Apr 16, 2021 · 2 comments

Comments

@loop-evgeny
Copy link

https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnection.html#methods shows only two methods now: Open() and OpenAsync(). NpgsqlConnection of course has a lot more methods than that!

@manandre
Copy link
Contributor

Hello, thanks for reporting this documentation issue. We like to know that people actually read it 😉

I have managed to reproduce the issue locally and it took me quite some time to understand what is happening here.
We use docfx to generate the documentation and it does not yet support the latest version of the C# language (C# 9.0) that we actively use in the code of Npgsql since it was released last November.

DocFx processing stops on the NpgsqlConnection.cs file on line 309, just after the Open and OpenAsync methods.
I have "fixed" the file by removing any use of C#9 features and the documentation for the NpgsqlConnection class is correctly generated.

@roji How can we get this DocFx issue fixed quickly? Can we help?

@roji
Copy link
Member

roji commented May 29, 2021

@manandre sorry for not commenting sooner, this slipped under my radar...

Unfortunately, docfx is... quite disappointing... AFAIK not even C# 8 is fully supported, and I tried pushing this both on the issue and internally, with little success. Unfortunately there isn't much we can do about it from our side, except keep signaling that this is important.

I'm going to close this now, but I encourage you guys to post on dotnet/docfx#6805 and on dotnet/docfx#4007, hopefully that will help...

@roji roji closed this as completed May 29, 2021
@roji roji transferred this issue from npgsql/npgsql Jun 1, 2021
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

No branches or pull requests

3 participants