dotnet / dotnet/dotnet-api-docs

The ReferenceEqualityComparer.Instance property is incorrectly shown as nullable

Ouverte
#4,875 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
area-System.Collections Pri3 untriaged
Langage dominant
C#
Étoiles
949
Forks
1.7k
Merge moyen
2 j 19 h
PR mergées (30 j)
52

Description

https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.referenceequalitycomparer.instance?view=net-5.0:

> ```cs
> public static System.Collections.Generic.ReferenceEqualityComparer? Instance { get; }
> ```

Having this property be nullable makes no sense. Docs tooling bug maybe? The .NET Core source shows that it's not nullable:

https://github.com/dotnet/runtime/blob/v5.0.0-rc.1.20451.14/src/libraries/Common/src/System/Collections/Generic/ReferenceEqualityComparer.cs#L30

```cs
///
/// Gets the singleton instance.
///
public static ReferenceEqualityComparer Instance { get; } = new ReferenceEqualityComparer();
```

https://github.com/dotnet/runtime/blob/v5.0.0-rc.1.20451.14/src/libraries/System.Collections/ref/System.Collections.cs#L418

```cs
public static System.Collections.Generic.ReferenceEqualityComparer Instance { get { throw null; } }
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Comparez la signature nullable de ReferenceEqualityComparer.Instance sur la page de l’API avec les déclarations d’exécution dans src/libraries/Common/src/System/Collections/Generic/ReferenceEqualityComparer.cs et src/libraries/System.Collections/ref/System.Collections.cs. Commencez par vérifier comment les outils de documentation dérivent la signature. La tâche est terminée lorsque la référence d’API générée affiche la propriété comme non nullable.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp
Domaine
documentation
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.