dotnet / dotnet/dotnet-api-docs

ToImmutableDictionary extension methods do not document throwing exceptions on key collisions

Open
#11,581 2 comments 1 reaction 0 assignees View on GitHub
area-System.Collections documentation untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

The current documentation for ToImmutableDictionary does not document that it throws on a key collision.

https://learn.microsoft.com/en-us/dotnet/api/system.collections.immutable.immutabledictionary.toimmutabledictionary?view=net-9.0

When converting a collection from a to b, the intuitive behavior would be to either skip the value or offer a method overload that gives the user an escape hatch. Since, it doesn't appear an escape hatch exists from the current api, I think at minimum this should be documented on the extension methods.

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.