dotnet / docfx

Static site generator for .NET API documentation.
https://dotnet.github.io/docfx/
MIT License
4.09k stars 867 forks source link

[Bug] cref to generic types renders type incoorrectly #10314

Open AlexeyRaga opened 1 month ago

AlexeyRaga commented 1 month ago

Describe the bug

Hete is the documentation I have:

/// <summary>
/// Provides a set of static methods for creating instances of <see cref="Either{_,_}"/> type.
/// </summary>
public static class Either

and here is how it renders by docfx:

Image

Expected behavior

I expect the type name to be rendered correctly and to be a link to EIther<TLeft, TRight> type, as an IDE would show:

Image

Or at least the type name, not "EP.Prelude.Either`2" which doesn't make much sense for documentation readers.

Context (please complete the following information):

AlexeyRaga commented 1 month ago

Oh, I think I've found the problem. I used to have "outputFormat": "apiPage" for my metadata and it didn't work.

yufeih commented 1 month ago

Re-open this for tracking. We should also fix the apiPage output in this case.