Skip to content

Commit 523953b

Browse files
Kasper Jungeclaude
authored andcommitted
docs: add missing event data fields so API users see what the engine actually emits
CHECK_PASSED/CHECK_FAILED events include `output`, iteration events include `result_text`, and CHECKS_COMPLETED results include `output` — all present in the code but missing from the docs. Also removes a stale "planned dashboard" reference from the RunConfig docstring. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 421e450 commit 523953b

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

docs/api.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,18 +224,18 @@ All event types the loop can emit. Every event has `type`, `run_id`, `timestamp`
224224
| Event type | When | Data fields |
225225
|---|---|---|
226226
| `ITERATION_STARTED` | Iteration begins | `iteration` |
227-
| `ITERATION_COMPLETED` | Agent exits with code 0 | `iteration`, `returncode`, `duration` (seconds), `duration_formatted`, `detail`, `log_file` |
228-
| `ITERATION_FAILED` | Agent exits non-zero | `iteration`, `returncode`, `duration`, `duration_formatted`, `detail`, `log_file` |
229-
| `ITERATION_TIMED_OUT` | Agent exceeds timeout | `iteration`, `returncode` (null), `duration`, `duration_formatted`, `detail`, `log_file` |
227+
| `ITERATION_COMPLETED` | Agent exits with code 0 | `iteration`, `returncode`, `duration` (seconds), `duration_formatted`, `detail`, `log_file`, `result_text` |
228+
| `ITERATION_FAILED` | Agent exits non-zero | `iteration`, `returncode`, `duration`, `duration_formatted`, `detail`, `log_file`, `result_text` |
229+
| `ITERATION_TIMED_OUT` | Agent exceeds timeout | `iteration`, `returncode` (null), `duration`, `duration_formatted`, `detail`, `log_file`, `result_text` |
230230

231231
#### Checks
232232

233233
| Event type | When | Data fields |
234234
|---|---|---|
235235
| `CHECKS_STARTED` | Check phase begins | `iteration`, `count` |
236-
| `CHECK_PASSED` | A single check passes | `iteration`, `name`, `passed`, `exit_code`, `timed_out` |
237-
| `CHECK_FAILED` | A single check fails | `iteration`, `name`, `passed`, `exit_code`, `timed_out` |
238-
| `CHECKS_COMPLETED` | All checks finish | `iteration`, `passed`, `failed`, `results` (array of `{name, passed, exit_code, timed_out}`) |
236+
| `CHECK_PASSED` | A single check passes | `iteration`, `name`, `passed`, `exit_code`, `timed_out`, `output` |
237+
| `CHECK_FAILED` | A single check fails | `iteration`, `name`, `passed`, `exit_code`, `timed_out`, `output` |
238+
| `CHECKS_COMPLETED` | All checks finish | `iteration`, `passed`, `failed`, `results` (array of `{name, passed, exit_code, timed_out, output}`) |
239239

240240
#### Prompt assembly
241241

src/ralphify/_run_types.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ class RunConfig:
4040
Mutable by design: the engine reads fields at each iteration boundary,
4141
so you can change ``max_iterations``, ``delay``, or ``timeout`` while
4242
the loop is running and the new values take effect on the next cycle.
43-
This is how the planned dashboard will let users tune a live run.
4443
4544
For CLI usage the config is built once from ``ralph.toml`` + flags.
4645
For programmatic usage, construct directly and pass to :func:`run_loop`.

0 commit comments

Comments
 (0)