apple / swift-algorithms

Commonly used sequence and collection algorithms for Swift
Apache License 2.0
5.9k stars 435 forks source link

Clarify the docs for `partitioned(by:)` #228

Closed j-f1 closed 3 months ago

j-f1 commented 4 months ago

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

j-f1 commented 4 months ago

@swift-ci please test

j-f1 commented 3 months ago

@swift-ci please test

j-f1 commented 3 months ago

@swift-ci please test