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

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

Open
AlexeyRaga opened this issue Oct 23, 2024 · 2 comments
Open

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

AlexeyRaga opened this issue Oct 23, 2024 · 2 comments
Labels
bug A bug to fix dotnet Generate .NET API reference docs

Comments

@AlexeyRaga
Copy link

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):

  • OS: MacOS
  • Docfx version: 2.77.0+bd00e2b93951e9e7fa6e5abd990d2cd77d7a83bd
@AlexeyRaga AlexeyRaga added the bug A bug to fix label Oct 23, 2024
@AlexeyRaga
Copy link
Author

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

@yufeih yufeih reopened this Oct 23, 2024
@yufeih
Copy link
Contributor

yufeih commented Oct 23, 2024

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

@yufeih yufeih added the dotnet Generate .NET API reference docs label Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A bug to fix dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants