Adding documentation and tests that maxBy/minBy return the first max/min element (Array, List, Seq) #19140
Conversation
…nd minBy functions on List, Array, and Seq modules. Also cleaned-up duplicate "exception on empty" documentation.
❗ Release notes requiredCaution No release notes found for the changed paths (see table below). Please make sure to add an entry with an informative description of the change as well as link to this pull request, issue and language suggestion if applicable. Release notes for this repository are based on Keep A Changelog format. The following format is recommended for this repository:
If you believe that release notes are not necessary for this PR, please add NO_RELEASE_NOTES label to the pull request. You can open this PR in browser to add release notes: open in github.dev
|
|
@dotnet-policy-service agree |
| /// <summary>Returns the greatest of all elements of the list, compared via Operators.max on the function result.</summary> | ||
| /// | ||
| /// <remarks>Raises <see cref="T:System.ArgumentException"/> if <c>list</c> is empty.</remarks> | ||
| /// <remarks>Returns the first maximal element of the list if there are multiple equal maximum elements.</remarks> |
There was a problem hiding this comment.
But we should also keep the remark about empty input (applies also to array)
There was a problem hiding this comment.
Shouldn't exception documentation use <exception> instead of <remarks>?
github-project-automation
bot
moved this from New
to In Progress
in F# Compiler and Tooling
3 participants
Description
Added documentation and tests that maxBy/minBy return the first max/min element (Array, List, Seq).
Added tests that the first min/max element is returned (Array, List, Seq).
I wasn't able to add a test in
CollectionModulesConsistencybecause I wasn't sure how to add it there because of the data generator.!! I wasn't able to run the tests (fsx.exe not found in SDK 🤷) !!
I also cleaned up the exception docu on empty array/list/seq (once in the exceptions section, once as a remark).
I hope that helps 😃
Feel free to ignore, improve, change, take parts, ...
Fixes #19129
Checklist