Skip to content

Commit 37a7e68

Browse files
docs: fix review comments (spelling, scope table, defaults)
1 parent a1f75cf commit 37a7e68

5 files changed

Lines changed: 19 additions & 19 deletions

File tree

docs/reference/api/reactor.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ All DSL words are aliased so they can be used without namespace qualification:
9595
| `UDP` | UDP socket events |
9696
| `TCP` | TCP socket events |
9797
| `Network<T>` | Networked data |
98-
| `Sync<T>` | Synchronisation group |
98+
| `Sync<T>` | Synchronization group |
9999
| `Single` | At most one task at a time |
100100
| `Buffer<N>` | Allow up to N concurrent tasks |
101101
| `Pool<T>` | Execute on a named thread pool |
@@ -125,15 +125,15 @@ static constexpr LogLevel FATAL = LogLevel::FATAL;
125125

126126
Accessed via the nested `Scope` struct:
127127

128-
| Scope | Description |
129-
| ---------------------- | ------------------------------ |
130-
| `Scope::LOCAL<T>` | Default; tasks via thread pool |
131-
| `Scope::INLINE<T>` | Execute in the emitting thread |
132-
| `Scope::DELAY<T>` | Delayed emission |
133-
| `Scope::INITIALIZE<T>` | Available before startup |
134-
| `Scope::NETWORK<T>` | Broadcast over network |
135-
| `Scope::UDP<T>` | Emit via UDP |
136-
| `Scope::WATCHDOG<T>` | Service a watchdog |
128+
| Scope | Description |
129+
| ------------------- | ------------------------------ |
130+
| `Scope::LOCAL` | Default; tasks via thread pool |
131+
| `Scope::INLINE` | Execute in the emitting thread |
132+
| `Scope::DELAY` | Delayed emission |
133+
| `Scope::INITIALIZE` | Available before startup |
134+
| `Scope::NETWORK` | Broadcast over network |
135+
| `Scope::UDP` | Emit via UDP |
136+
| `Scope::WATCHDOG` | Service a watchdog |
137137

138138
## Example
139139

docs/reference/dsl/group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ on<Trigger<T>, Group<GroupType>>()
1818

1919
```cpp
2020
struct GroupType {
21-
static constexpr int concurrency = N;
21+
static constexpr int concurrency = N; // defaults to 1 if omitted
2222
};
2323
```
2424
2525
## Behavior
2626
27-
- At most `GroupType::concurrency` tasks from the group execute simultaneously.
27+
- At most `GroupType::concurrency` tasks from the group execute simultaneously (defaults to 1 if omitted).
2828
- Tasks that exceed the concurrency limit are queued and dispatched by priority.
2929
- Groups are identified by type — the same `GroupType` used in different reactors refers to the same group.
3030
- A reaction can belong to multiple groups.

docs/reference/dsl/inline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ on<Trigger<T>, Inline::NEVER>().then([](const T& t) { /* ... */ });
1111
1212
## Modes
1313
14-
| Mode | Behaviour |
14+
| Mode | Behavior |
1515
| ---------------- | ------------------------------------------------------------------------- |
1616
| `Inline::ALWAYS` | Task runs immediately on the emitting thread, bypassing the scheduler. |
1717
| `Inline::NEVER` | Task is always queued to the thread pool, even from an inline emit scope. |
1818
| *(default)* | NEUTRAL — respects the emit scope used by the caller. |
1919
2020
If both `Inline::ALWAYS` and `Inline::NEVER` are specified on the same reaction, a `std::logic_error` is thrown at binding time.
2121
22-
## Behaviour
22+
## Behavior
2323
2424
```mermaid
2525
flowchart LR

docs/reference/dsl/pool.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ on<Trigger<T>, Pool<PoolType>>().then([](const T& data) {
1616

1717
The struct must satisfy:
1818

19-
| Member | Type | Description |
20-
| ------------- | ------------------------------ | ---------------------------------------------------- |
21-
| `name` | `static constexpr const char*` | Name assigned to pool threads (visible in debuggers) |
22-
| `concurrency` | `static constexpr int` | Number of threads in the pool |
19+
| Member | Type | Description |
20+
| ------------- | ------------------------------ | ------------------------------------------------------------------------------ |
21+
| `name` | `static constexpr const char*` | Optional. Name assigned to pool threads (defaults to the demangled type name). |
22+
| `concurrency` | `static constexpr int` | Required. Number of threads in the pool. |
2323

2424
```cpp
2525
struct GPUPool {

docs/reference/dsl/priority.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ on<Trigger<T>, Priority::IDLE>()
2222
| LOW | 250 | Background processing |
2323
| IDLE | 0 | Only when nothing else to do |
2424

25-
## Behaviour
25+
## Behavior
2626

2727
Higher priority tasks are dequeued before lower priority tasks when a thread becomes available.
2828
Priority affects only queuing order — it does not preempt tasks that are already running.

0 commit comments

Comments
 (0)