npgsql
Cross-references in XML docs not rendering.
In the XML docs for the NpgsqlCommand.CommandType member we can see references to System.Data.CommandType and System.Data.CommandType.Text as follows:
However the output on the docs site doesn't show links or text for those references, instead we have this:
What gives?
A similar thing happens with UpdatedRowSource which looks like this in code:
...but renders like this on the docs site:
@ericmutta this happens with references to types which are outside this repo (i.e. in System.Data). References within the repo seem to render well (e.g. NpgsqlCommand.Connection).
IIRC it may be possible to point docfx (the tool that generates our documentation) to XML documentation for the .NET runtime, which would mean our docs point to the standard .NET docs, but I've never had the time to exlpore this more deeply. You're of course welcome to look into this if you're interested, but I'm not sure it's going to be trivial or even possible (not sure that there are accessible XML doc files for the .NET runtime APIs).
@roji it looks like others faced the same issue and a fix was pushed to the DocFX repo last year, where unresolved references just render the text "as is" instead of removing it entirely. If we are not already using the latest version of DocFX, perhaps updating to the latest version may fix the issue?
We're currently using docfx 2.59.2 which was released in April 2022, whereas https://github.com/dotnet/docfx/pull/7325 looks like it was merged - and the commit is even reachable from the v2.59.2 tag.. so maybe that fix is insufficient for our case...
(submitted #244 to bump to 2.59.4, the latest v2)
