Skip to content

Minor documentation fixes #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dietmarkuehl merged 2 commits into from
May 24, 2025
Merged

Minor documentation fixes #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c04a47
minor documentation fixes
dietmarkuehl May 14, 2025
a1876aa
remove stray `
dietmarkuehl May 14, 2025
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Contributing to `beman::execution`

We welcome all constructive contributions! You will have something you
can contribute independent of your level expertise!
can contribute independent of your level of expertise!

There is a huge range of contributions needed and welcome! Here is an
incomplete list of starting points for contributions:
Expand All @@ -21,7 +21,7 @@ incomplete list of starting points for contributions:
* The layout of some pages related to the project can be improved.
* Some behaviour 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/contributing.md) page.
[resources](https://github.com/bemanproject/execution/blob/main/docs/resources.md) page.
* There are [pull requests](https://github.com/bemanproject/execution/pulls)
which could be reviewed.
* This very page or list is lacking something.
Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ static_assert(not std::execution::receiver_of<example_receiver,
Schedulers are used to specify the execution context where the asynchronous work is to be executed. A scheduler is a lightweight handle providing a <code><a href=‘#schedule’>schedule</a></code> operation yielding a <code><a href=‘sender’>sender</a></code> with a value <a href=‘#completion-signal’>completion signal</a> without parameters. The completion is on the respective execution context.

Requirements for <code>_Scheduler_</code>:
- The type <code>_Scheduler_::scheduler_concept</code> is an alias for `scheduler_t` or a type derived thereof`.
- The type <code>_Scheduler_::scheduler_concept</code> is an alias for `scheduler_t` or a type derived thereof.
- <code><a href=‘#schedule’>schedule</a>(_scheduler_) -> <a href=‘sender’>sender</a></code>
- The <a href=‘#get-completion-scheduler’>value completion scheduler</a> of the <code><a href=‘sender’>sender</a></code>’s <a href=‘#environment’>environment</a> is the <code>_scheduler_</code>:
_scheduler_ == std::execution::get_completion_scheduler&lt;std::execution::set_value_t&gt;(
Expand Down
Loading