Open mdznr opened 3 years ago
It's a good question.
I can't recall, but I imagine we just followed the precedent set by partition(by:)
from the standard library which does not mark its result as a @discardableResult
.
While it could be argued that
bringForward(elementsSatisfying:)
should return anIndex
as well, even that return value isn’t always needed to be used and should be marked as@discardableResult
.
I do think bringForward(elementsSatisfying:)
should probably return an Index
(one of Alexander Stepanov's API design principles is "don't throw away useful information"), but I agree that should arguably be marked as @discardableResult
.
@discardableResult #67
The standard library can also be changed. If not now, then in Swift 6.
Using the mutating partitioning functions are useful even when the returned index isn’t used.
The Embracing Algorithms (WWDC 2018) session implements a
bringForward(elementsSatisfying:)
function onMutableCollection
.1 It usesstablePartition(by:)
in its implementation, but doesn’t need its return value, resulting in a warning.Actual behavior
Expected behavior
While it could be argued that
bringForward(elementsSatisfying:)
should return anIndex
as well, even that return value isn’t always needed to be used and should be marked as@discardableResult
.Checklist
main
branch of this package