search

apple / swift-async-algorithms

Async Algorithms for Swift
Apache License 2.0
3.06k stars 151 forks source link

Make throttle underscored #296

Closed FranzBusch closed 1 year ago

FranzBusch commented 1 year ago

Motivation

During the discussion in https://github.com/apple/swift-async-algorithms/issues/248 it became clear that the semantics of throttle are not 100% figured out yet.

Modification

This PR is making throttle an underscored API for the upcoming 1.0.0 release. This gives us more time to investigate what exact semantics we want to have.

phausler commented 1 year ago

I think this should probably be public but underscored.

FranzBusch commented 1 year ago

@swift-ci please test

phausler commented 1 year ago

@swift-ci please test

robertmryan commented 2 months ago

I'm not sure where the appropriate place to post this observation, but if we’ve changed throttle to _throttle, perhaps we should modify the associated documentation accordingly (and maybe offer some guidance, i.e., what the concern was, or advice as to whether to avoid using it at all, or whatever).