Skip to content
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

Jump to bottom

Min/MaxBy documented return type incorrectly mentions singular value #764

Closed
GuntherStruyf opened this issue Oct 10, 2020 · 3 comments · Fixed by #765
Closed

Min/MaxBy documented return type incorrectly mentions singular value #764

GuntherStruyf opened this issue Oct 10, 2020 · 3 comments · Fixed by #765
Labels
docs
Milestone
3.4.0

Comments

@GuntherStruyf
Copy link

Confusing for new users who inspect the documented return type, this stems from #328 #369 "Change MaxBy/MinBy to return all extrema elements". The summary was updated, the documented return type not.

summary:

Returns the minimal element s of the given sequence, based on the given projection.
= plural

returns:

The minimal element, according to the projection.
= singular
@atifaziz atifaziz added the docs label Oct 28, 2020
@atifaziz
Copy link
Member

Thanks for pointing this out!

@atifaziz atifaziz added this to the 3.4.0 milestone Oct 28, 2020
@atifaziz atifaziz changed the title MinBy/MaxBy documented return type mentions singular value instead of all extrema values. Min/MaxBy documented return type incorrectly mentions singular value Oct 28, 2020
@atifaziz atifaziz mentioned this issue Oct 28, 2020
Merged
@atifaziz
Copy link
Member

@GuntherStruyf Feel free to review and bless PR #765!

@atifaziz atifaziz linked a pull request Oct 29, 2020 that will close this issue
Fix return value docs for MinBy/MaxBy #765
Merged
@atifaziz
Copy link
Member

Closed via e384ba0 (merge of PR #765).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
3.4.0
Development

Successfully merging a pull request may close this issue.

Fix return value docs for MinBy/MaxBy atifaziz/MoreLINQ
2 participants
@atifaziz @GuntherStruyf