Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ incomplete list of starting points for contributions:
created.
* The [issues page](https://github.com/bemanproject/execution/issues) lists
known issues.
* The implememtation of a component may be missing.
* The implementation of a component may be missing.
* The layout of some pages related to the project can be improved.
* Some behaviour of a component isn't tested or documented.
* Some behavior of a component isn't tested or documented.
* You found something which should be linked from the
[resources](https://github.com/bemanproject/execution/blob/main/docs/resources.md) page.
* There are [pull requests](https://github.com/bemanproject/execution/pulls)
Expand Down
2 changes: 1 addition & 1 deletion docs/intro-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ synchronously produce the result. The intention is to show a basic
use of some involved components to build up a feeling of how things
work.

The componentes for `std::execution` are declared in the header
The components for `std::execution` are declared in the header
`<execution>`. This particular implementation implements the
cmponents in namespace `beman::execution` declared in the header
`<beman/execution/execution.hpp>`:
Expand Down
6 changes: 3 additions & 3 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ struct custom_t: forwarding_query_t {
<summary><code>get_env(<i>queryable</i>) -> <i>env</i></code></summary>
**Default**: <a href='#empty_env'>`empty_env`</a>
<br/>
The expresion <code>get_env(<i>queryable</i>)</code> is used to get the environment <code><i>env</i></code> associated with <code><i>queryable</i></code>. To provide a non-default environment for a <code><i>queryable</i></code> a `get_env` member needs to be defined. If <code><i>queryable</i></code> doesn’t provide the <code>get_env</code> query an object of type <code><a href=‘#empty_env’>empty_env</a></code> is returned.
The expression <code>get_env(<i>queryable</i>)</code> is used to get the environment <code><i>env</i></code> associated with <code><i>queryable</i></code>. To provide a non-default environment for a <code><i>queryable</i></code> a `get_env` member needs to be defined. If <code><i>queryable</i></code> doesn’t provide the <code>get_env</code> query an object of type <code><a href=‘#empty_env’>empty_env</a></code> is returned.
The value of the expression is <ol>
<li>the result of <code>as_const(<i>queryable</i>).get_env()</code> if this expression is valid and <code>noexcept</code>.</li>
<li><code>empty_env</code> otherwise.
Expand Down Expand Up @@ -560,7 +560,7 @@ Otherwise the value is <code>never_stop_token{}</code>.

<details>
<summary><code>connect(<i>sender</i>, <i>receiver</i>) -> <i>operation_state</i></code></summary>
The expresion <code>connect(<i>sender</i>, <i>receiver</i>)</code> combines <code><i>sender</i></code> and <code><i>receiver</i></code> into an operation state <code><i>state</i></code>. When this <code><i>state</i></code> gets started using <code>start(<i>state</i>)</code> the operation represented by <code><i>sender</i></code> gets started and reports its completion to <code><i>receiver</i></code> or an object copied or moved from <code><i>receiver</i></code>. While the operation state <code><i>state</i></code> isn’t started it can be destroyed but once it got started it needs to stay valid until one of the completion signals is called on <code><i>receiver</i></code>.
The expression <code>connect(<i>sender</i>, <i>receiver</i>)</code> combines <code><i>sender</i></code> and <code><i>receiver</i></code> into an operation state <code><i>state</i></code>. When this <code><i>state</i></code> gets started using <code>start(<i>state</i>)</code> the operation represented by <code><i>sender</i></code> gets started and reports its completion to <code><i>receiver</i></code> or an object copied or moved from <code><i>receiver</i></code>. While the operation state <code><i>state</i></code> isn’t started it can be destroyed but once it got started it needs to stay valid until one of the completion signals is called on <code><i>receiver</i></code>.
</details>
<details>
<summary><code>set_error(<i>receiver</i>, <i>error</i>) noexcept -> void</code></summary>
Expand Down Expand Up @@ -655,7 +655,7 @@ The expression <code>continues_on(<i>sender</i>, <i>scheduler</i>)</code> create
</details>
<details>
<summary><code>into_variant(<i>sender</i>) -> <i>sender-of</i>&lt;set_value_t(std::variant&lt;<i>Tuple</i>...&gt;)&gt;</code></summary>
The expression <code>into_variant(<i>sender</i>)</code> creates a sender which transforms the results of possibly multiple <code>set_value</code> completions of <code><i>sender</i></code> into one <code>set_value</code> completion respresenting the different upstream results as different options of a <code>variant&lt;<i>Tuple</i>...&gt;</code> where each <code><i>Tuple</i></code> is a <code>tuple</code> of values initialized with the respective arguments passed to <code>set_value</code>. The order of options in the <code>variant</code> isn’t specified.
The expression <code>into_variant(<i>sender</i>)</code> creates a sender which transforms the results of possibly multiple <code>set_value</code> completions of <code><i>sender</i></code> into one <code>set_value</code> completion representing the different upstream results as different options of a <code>variant&lt;<i>Tuple</i>...&gt;</code> where each <code><i>Tuple</i></code> is a <code>tuple</code> of values initialized with the respective arguments passed to <code>set_value</code>. The order of options in the <code>variant</code> isn’t specified.
</details>
<details>
<summary><code>let_error(<i>upstream</i>, <i>fun</i>) -> <i>sender</i></code></summary>
Expand Down