Skip to content

Commit 196e80d

Browse files
authored
fix typos in the documentation (#165)
1 parent 17edffe commit 196e80d

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ incomplete list of starting points for contributions:
1717
created.
1818
* The [issues page](https://github.com/bemanproject/execution/issues) lists
1919
known issues.
20-
* The implememtation of a component may be missing.
20+
* The implementation of a component may be missing.
2121
* The layout of some pages related to the project can be improved.
22-
* Some behaviour of a component isn't tested or documented.
22+
* Some behavior of a component isn't tested or documented.
2323
* You found something which should be linked from the
2424
[resources](https://github.com/bemanproject/execution/blob/main/docs/resources.md) page.
2525
* There are [pull requests](https://github.com/bemanproject/execution/pulls)

docs/intro-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ synchronously produce the result. The intention is to show a basic
1717
use of some involved components to build up a feeling of how things
1818
work.
1919

20-
The componentes for `std::execution` are declared in the header
20+
The components for `std::execution` are declared in the header
2121
`<execution>`. This particular implementation implements the
2222
cmponents in namespace `beman::execution` declared in the header
2323
`<beman/execution/execution.hpp>`:

docs/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ struct custom_t: forwarding_query_t {
409409
<summary><code>get_env(<i>queryable</i>) -> <i>env</i></code></summary>
410410
**Default**: <a href='#empty_env'>`empty_env`</a>
411411
<br/>
412-
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.
412+
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.
413413
The value of the expression is <ol>
414414
<li>the result of <code>as_const(<i>queryable</i>).get_env()</code> if this expression is valid and <code>noexcept</code>.</li>
415415
<li><code>empty_env</code> otherwise.
@@ -560,7 +560,7 @@ Otherwise the value is <code>never_stop_token{}</code>.
560560

561561
<details>
562562
<summary><code>connect(<i>sender</i>, <i>receiver</i>) -> <i>operation_state</i></code></summary>
563-
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>.
563+
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>.
564564
</details>
565565
<details>
566566
<summary><code>set_error(<i>receiver</i>, <i>error</i>) noexcept -> void</code></summary>
@@ -655,7 +655,7 @@ The expression <code>continues_on(<i>sender</i>, <i>scheduler</i>)</code> create
655655
</details>
656656
<details>
657657
<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>
658-
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.
658+
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.
659659
</details>
660660
<details>
661661
<summary><code>let_error(<i>upstream</i>, <i>fun</i>) -> <i>sender</i></code></summary>

0 commit comments

Comments
 (0)