Skip to content

Commit

Permalink
Update via docs
Browse files Browse the repository at this point in the history
Remove deprecated `typed_via` and fix parameter order in `via.`
  • Loading branch information
ccotter authored Dec 26, 2023
1 parent e14d5ca commit 835c99b
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions doc/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ Note that `completion` sender must complete with an empty value pack
if it completes with `set_value`.
ie. it must be a `void`-value sender.

### `via(Scheduler scheduler, Sender sender) -> Sender`
### `via(Sender sender, Scheduler scheduler) -> Sender`

Returns a sender that produces the result from `sender` on the
execution context associated with `scheduler`.
Expand All @@ -439,13 +439,6 @@ If the result of `schedule(scheduler)` completes with `set_done()` then
`set_done()` is sent. If the result of `schedule(scheduler)` completes with
`set_error()` then its error is sent. Otherwise sends the result of `sender`.

### `typed_via(Sender source, Scheduler scheduler) -> Sender`

Returns a sender that produces the result from `source`, which must
declare the nested `value_types`/`error_types` type aliases which describe which
overloads of `set_value()`/`set_error()` they will call, on the execution context
associated with `scheduler`.

### `on(Scheduler scheduler, Sender sender) -> Sender`

Returns a sender that ensures that `sender` is started on the
Expand Down

0 comments on commit 835c99b

Please sign in to comment.