Skip to content

Update remarks and exceptions for MaxBy/MinBy #9321

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

Merged
merged 5 commits into from
Sep 26, 2023
Merged

Update remarks and exceptions for MaxBy/MinBy #9321

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc1edf2
update remarks and exceptions for maxby/minby
gewarren Sep 22, 2023
e0f391c
add exception to remarks
gewarren Sep 25, 2023
9d3124f
add closing tag
gewarren Sep 25, 2023
d452d94
fix tags
gewarren Sep 25, 2023
9dd7048
respond to feedback
gewarren Sep 26, 2023
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
52 changes: 16 additions & 36 deletions xml/System.Linq/Enumerable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8257,18 +8257,13 @@ In Visual Basic query expression syntax, an `Aggregate Into Max()` clause transl
<param name="keySelector">A function to extract the key for each element.</param>
<summary>Returns the maximum value in a generic sequence according to a specified key selector function.</summary>
<returns>The value with the maximum key in the sequence.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

If `TKey` is a reference type and the source sequence is empty or contains only values that are `null`, this method returns `null`.

]]></format>
</remarks>
<remarks><para>If the source sequence is empty and <typeparamref name="TSource" /> is a nullable type, this method returns <see langword="null" />. If the source sequence is empty and <typeparamref name="TSource" /> is a non-nullable struct, such as a primitive type, an <see cref="T:System.InvalidOperationException" /> is thrown.</para>
<para>If the source sequence contains only values that are <see langword="null" />.</para></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">No key extracted from <paramref name="source" /> implements the <see cref="T:System.IComparable" /> or <see cref="T:System.IComparable`1" /> interface.</exception>
<exception cref="T:System.InvalidOperationException">
<typeparamref name="TSource" /> is a primitive type and the source sequence is empty.</exception>
</Docs>
</Member>
<Member MemberName="MaxBy&lt;TSource,TKey&gt;">
Expand Down Expand Up @@ -8338,18 +8333,13 @@ If `TKey` is a reference type and the source sequence is empty or contains only
<param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1" /> to compare keys.</param>
<summary>Returns the maximum value in a generic sequence according to a specified key selector function and key comparer.</summary>
<returns>The value with the maximum key in the sequence.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

If `TKey` is a reference type and the source sequence is empty or contains only values that are `null`, this method returns `null`.

]]></format>
</remarks>
<remarks><para>If the source sequence is empty and <typeparamref name="TSource" /> is a nullable type, this method returns <see langword="null" />. If the source sequence is empty and <typeparamref name="TSource" /> is a non-nullable struct, such as a primitive type, an <see cref="T:System.InvalidOperationException" /> is thrown.</para>
<para>If the source sequence contains only values that are <see langword="null" />.</para></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">No key extracted from <paramref name="source" /> implements the <see cref="T:System.IComparable" /> or <see cref="T:System.IComparable`1" /> interface.</exception>
<exception cref="T:System.InvalidOperationException">
<typeparamref name="TSource" /> is a primitive type and the source sequence is empty.</exception>
</Docs>
</Member>
<MemberGroup MemberName="Min">
Expand Down Expand Up @@ -10061,18 +10051,13 @@ In Visual Basic query expression syntax, an `Aggregate Into Min()` clause transl
<param name="keySelector">A function to extract the key for each element.</param>
<summary>Returns the minimum value in a generic sequence according to a specified key selector function.</summary>
<returns>The value with the minimum key in the sequence.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

If `TKey` is a reference type and the source sequence is empty or contains only values that are `null`, this method returns `null`.

]]></format>
</remarks>
<remarks><para>If the source sequence is empty and <typeparamref name="TSource" /> is a nullable type, this method returns <see langword="null" />. If the source sequence is empty and <typeparamref name="TSource" /> is a non-nullable struct, such as a primitive type, an <see cref="T:System.InvalidOperationException" /> is thrown.</para>
<para>If the source sequence contains only values that are <see langword="null" />.</para></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">No key extracted from <paramref name="source" /> implements the <see cref="T:System.IComparable" /> or <see cref="T:System.IComparable`1" /> interface.</exception>
<exception cref="T:System.InvalidOperationException">
<typeparamref name="TSource" /> is a primitive type and the source sequence is empty.</exception>
</Docs>
</Member>
<Member MemberName="MinBy&lt;TSource,TKey&gt;">
Expand Down Expand Up @@ -10142,18 +10127,13 @@ If `TKey` is a reference type and the source sequence is empty or contains only
<param name="comparer">The <see cref="T:System.Collections.Generic.IComparer`1" /> to compare keys.</param>
<summary>Returns the minimum value in a generic sequence according to a specified key selector function and key comparer.</summary>
<returns>The value with the minimum key in the sequence.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

If `TKey` is a reference type and the source sequence is empty or contains only values that are `null`, this method returns `null`.

]]></format>
</remarks>
<remarks><para>If the source sequence is empty and <typeparamref name="TSource" /> is a nullable type, this method returns <see langword="null" />. If the source sequence is empty and <typeparamref name="TSource" /> is a non-nullable struct, such as a primitive type, an <see cref="T:System.InvalidOperationException" /> is thrown.</para>
<para>If the source sequence contains only values that are <see langword="null" />.</para></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">No key extracted from <paramref name="source" /> implements the <see cref="T:System.IComparable" /> or <see cref="T:System.IComparable`1" /> interface.</exception>
<exception cref="T:System.InvalidOperationException">
<typeparamref name="TSource" /> is a primitive type and the source sequence is empty.</exception>
</Docs>
</Member>
<Member MemberName="OfType&lt;TResult&gt;">
Expand Down