Clarify the docs for partitioned(by:)
#228
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As currently written, the summary for
partitioned(by:)
heavily implies the return value is(trueValues, falseValues)
. In fact, it’s the opposite. I rephrased this summary to clarify that (1) the order is(falseValues, trueValues)
and (2) the elements of the two returned arrays are in the order they were in the original sequence/collection.Checklist