dotnet / dotnet/docfx

[Bug] cref to generic types renders type incoorrectly

Open
#10,314 2 comments 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Describe the bug**

Hete is the documentation I have:

```csharp
///
/// Provides a set of static methods for creating instances of type.
///
public static class Either
```

and here is how it renders by `docfx`:

![Image](https://github.com/user-attachments/assets/a7027a99-1ba5-4ca8-ab1f-2ef4173a86a9)

**Expected behavior**

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

![Image](https://github.com/user-attachments/assets/2a5a0e19-c664-4033-af66-66027369c45a)

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`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.