dotnet / dotnet/dotnet-api-docs

The ReferenceEqualityComparer.Instance property is incorrectly shown as nullable

オープン
#4,875 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
area-System.Collections Pri3 untriaged
主要言語
C#
スター
949
フォーク
1.7k
平均マージ
2日 19時間
マージ済み PR(30日)
52

説明

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; } }
```

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

API ページの ReferenceEqualityComparer.Instance の nullable シグネチャを、src/libraries/Common/src/System/Collections/Generic/ReferenceEqualityComparer.cs と src/libraries/System.Collections/ref/System.Collections.cs のランタイム宣言と比較します。まず、ドキュメント ツールがシグネチャをどのように導出しているかを確認します。生成された API リファレンスでプロパティが non-nullable として表示されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp
領域
documentation
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。