Skip to content

[Frozen] Document duplicate handling in summaries of all FrozenDictionary factory methods #134318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
priyadarshnisundararajan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Frozen] Document duplicate handling in summaries of all FrozenDictionary factory methods #134318

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5c3d65
[Frozen] Document duplicate handling in summaries of all FrozenDictio…
priyadarshnisundararajan Sep 21, 2026
37ec909
Merge branch 'main' into docs/frozen-dictionary-duplicate-handling
priyadarshnisundararajan Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/libraries/System.Collections.Immutable/src/System/Collections/Frozen/FrozenDictionary.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace System.Collections.Frozen
/// </summary>
public static class FrozenDictionary
{
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs.</summary>
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs. If the same key appears multiple times in the input, the latter one in the sequence takes precedence.</summary>
/// <param name="source">The key/value pairs to use to populate the dictionary.</param>
/// <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
/// <typeparam name="TValue">The type of the values in the dictionary.</typeparam>
Expand All @@ -29,7 +29,7 @@ public static FrozenDictionary<TKey, TValue> Create<TKey, TValue>(params ReadOnl
where TKey : notnull =>
Create(null, source);

/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs.</summary>
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs. If the same key appears multiple times in the input, the latter one in the sequence takes precedence.</summary>
/// <param name="source">The key/value pairs to use to populate the dictionary.</param>
/// <param name="comparer">The comparer implementation to use to compare keys for equality. If <see langword="null"/>, <see cref="EqualityComparer{TKey}.Default"/> is used.</param>
/// <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
Expand Down Expand Up @@ -60,7 +60,7 @@ public static FrozenDictionary<TKey, TValue> Create<TKey, TValue>(IEqualityCompa
return CreateFromDictionary(d);
}

/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs.</summary>
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TValue}"/> with the specified key/value pairs. If the same key appears multiple times in the input, the latter one in the sequence takes precedence.</summary>
/// <param name="source">The key/value pairs to use to populate the dictionary.</param>
/// <param name="comparer">The comparer implementation to use to compare keys for equality. If null, <see cref="EqualityComparer{TKey}.Default"/> is used.</param>
/// <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
Expand All @@ -75,7 +75,7 @@ public static FrozenDictionary<TKey, TValue> ToFrozenDictionary<TKey, TValue>(th
GetExistingFrozenOrNewDictionary(source, comparer, out Dictionary<TKey, TValue>? uniqueValues) ??
CreateFromDictionary(uniqueValues!);

/// <summary>Creates a <see cref="FrozenDictionary{TKey, TSource}"/> from an <see cref="IEnumerable{TSource}"/> according to specified key selector function.</summary>
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TSource}"/> from an <see cref="IEnumerable{TSource}"/> according to specified key selector function. Unlike the key/value pair-based overloads, this overload throws an <see cref="ArgumentException"/> if <paramref name="keySelector"/> produces duplicate keys.</summary>
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <typeparam name="TKey">The type of the key returned by <paramref name="keySelector"/>.</typeparam>
/// <param name="source">An <see cref="IEnumerable{TSource}"/> from which to create a <see cref="FrozenDictionary{TKey, TSource}"/>.</param>
Expand All @@ -87,7 +87,7 @@ public static FrozenDictionary<TKey, TSource> ToFrozenDictionary<TSource, TKey>(
where TKey : notnull =>
source.ToDictionary(keySelector, comparer).ToFrozenDictionary(comparer);

/// <summary>Creates a <see cref="FrozenDictionary{TKey, TElement}"/> from an <see cref="IEnumerable{TSource}"/> according to specified key selector and element selector functions.</summary>
/// <summary>Creates a <see cref="FrozenDictionary{TKey, TElement}"/> from an <see cref="IEnumerable{TSource}"/> according to specified key selector and element selector functions. Unlike the key/value pair-based overloads, this overload throws an <see cref="ArgumentException"/> if <paramref name="keySelector"/> produces duplicate keys.</summary>
/// <typeparam name="TSource">The type of the elements of <paramref name="source"/>.</typeparam>
/// <typeparam name="TKey">The type of the key returned by <paramref name="keySelector"/>.</typeparam>
/// <typeparam name="TElement">The type of the value returned by <paramref name="elementSelector"/>.</typeparam>
Expand Down
Loading