dotnet / dotnet/dotnet-api-docs

Add missing exception xml description for IReadOnlyList<T>, IReadOnlyDictionary<TKey, TValue> as well as for IReadOnlySet<T>

Open
#6,910 4 comments 0 reactions 0 assignees View on GitHub
area-System.Collections Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

**[IReadOnlySet](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/IReadOnlySet.cs)** interface contains descriptions of exceptions for some of the methods.

Perhaps it makes sense to add similar exception descriptions for `IReadOnlyList`, `IReadOnlyDictionary` interfaces as well.

E. g.
**[IReadOnlyDictionary](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/IReadOnlyDictionary.cs)**:
* `ContainsKey` - add description for `ArgumentNullException` (as in `Dictionary` class)
* `TryGetValue` - add description for `ArgumentNullException` (as in `Dictionary` class)
* `Indexer` - add description for `ArgumentNullException` and `KeyNotFoundException` (as in `Dictionary` class)

**[IReadOnlyList](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/Collections/Generic/IReadOnlyList.cs)**:
* `Indexer` - add description for `ArgumentOutOfRangeException` (as in `List` class)

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.