docs(#2569): address argus review — add Errors/Panics doc sections + fix ClearTodo keyless-clear semantics
This commit is contained in:
parent
8149dc7633
commit
565b1b90fc
3 changed files with 61 additions and 5 deletions
|
|
@ -453,9 +453,12 @@ pub enum Request {
|
|||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
source: Option<String>,
|
||||
},
|
||||
/// Clear a producer-resolved todo by `(subsystem, key)`. `key = None`
|
||||
/// targets the keyless one-off; `all = true` wipes the producer's
|
||||
/// whole set (cancel-and-recreate on daemon restart).
|
||||
/// Clear producer-resolved todo(s) by `(subsystem, key)`. `key =
|
||||
/// Some(k)` clears the one keyed row; `key = None` clears **all** of
|
||||
/// the subsystem's keyless todos (rows with no key can't be told
|
||||
/// apart — clear a specific one via `MarkTodoDone` by id). `all =
|
||||
/// true` wipes the producer's whole set (cancel-and-recreate on
|
||||
/// daemon restart).
|
||||
ClearTodo {
|
||||
subsystem: String,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
|
|
|
|||
Loading…
Reference in a new issue