You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/api.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,14 +56,18 @@ non-default parent is added).
56
56
57
57
| Member | Purpose |
58
58
| --- | --- |
59
-
|`validate_room_id(room_id)`| enforce the room-id / path-segment rule (`ROOM_ID_RE`); raises `AddRoomError`|
59
+
|`validate_room_id(room_id)`| enforce the room-id / path-segment rule (`ROOM_ID_RE`); raises `BadRoomId`|
60
60
|`resolve_project(project_dir)`| resolve + verify the stack root (has `COMPOSE_FILE` and `INSTALLATION_FILE`) |
61
61
|`resolve_package_name(project, override)`| the stack's own package (inferred from `src/<pkg>/tools.py`) or `DEFAULT_PACKAGE_NAME`|
62
62
|`room_parent_candidates(project)`| the `room_paths` container entries a caller can offer as a `parent_path` (or `["./rooms"]` when absent) |
63
63
|`install_room(project, room_id, *, config_text, prompt_text=None, parent_path, force=False, dry_run=False)`| write the room dir from a rendered `config_text` (+ optional prompt) under `parent_path` and wire `room_paths`|
64
64
|`install_room_from(project, room_id, src_dir, *, parent_path, force=False, dry_run=False)`| the same, but *copy* the `src_dir` template tree (multi-file); the caller patches the copied files afterward |
65
65
|`RoomInstalled(config_path, path_action)`| the install outcome (alias `RoomInstall` kept for back-compat) |
66
-
|`AddRoomError`| user-facing error with message-factory classmethods (incl. `bad_room_id`, `parent_is_room`) |
66
+
|`AddRoomError`| base class for user-facing errors |
67
+
|`ComposeNotFound(AddRoomError)`| No `docker-compose.yaml` found |
0 commit comments