From 309adec07fdd2aa0f87232357b382ad72751b3b3 Mon Sep 17 00:00:00 2001 From: atlas Date: Sun, 26 Jul 2026 02:58:36 +0200 Subject: [PATCH] docs: add # Errors section to Coordinator::set_paused --- hive-c0re/src/coordinator.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/hive-c0re/src/coordinator.rs b/hive-c0re/src/coordinator.rs index b910af2b..e1cbd9ad 100644 --- a/hive-c0re/src/coordinator.rs +++ b/hive-c0re/src/coordinator.rs @@ -1471,6 +1471,13 @@ impl Coordinator { /// directions: pausing an already-paused agent (or resuming a /// running one) is a no-op rather than an error, so the dashboard /// toggle and `hivectl pause|resume` don't have to read-then-write. + /// + /// # Errors + /// + /// Returns the underlying `io::Error` when the marker can't be + /// created (agent dir missing and un-creatable, permissions, disk + /// full) or can't be removed. A `NotFound` on removal is *not* an + /// error — that's the idempotent resume case. pub fn set_paused(name: &hive_types::Ident, paused: bool) -> std::io::Result<()> { let marker = Self::agent_paused_marker(name); if paused {