hive-forge: add # Errors docs on every verb's pub fn run (closes #816)
systemic gap argus flagged on PR #798 (timeline verb). every `pub fn run` in hive-forge/src/verbs/*.rs lacked a `# Errors` block — violates Rust API guidelines + obscures the failure surface for operators reading the source. uniform doc per verb category: - pure GET + print verbs: "transport error from the Forgejo REST call + I/O error from stdout" - body-from-file verbs (comment/comment_edit/issue_create/issue_edit/ pr_create): adds 'I/O error from --body-file/stdin input' - file-upload verbs (attach-issue, attach-comment): adds 'file read/exist check' - pr_create: also mentions the --push shellout 23 `pub fn run` signatures touched. no behaviour change; pure documentation sweep. cargo test green (38 tests).
This commit is contained in:
parent
a12c097044
commit
1195bfbe11
23 changed files with 130 additions and 0 deletions
|
|
@ -51,6 +51,13 @@ pub struct Args {
|
|||
remote: String,
|
||||
}
|
||||
|
||||
/// # Errors
|
||||
///
|
||||
/// Propagates any I/O error from the body input (`--body-file`,
|
||||
/// stdin) or the `--push` shellout to git, any transport error from
|
||||
/// the Forgejo REST call (network unreachable, 4xx/5xx response,
|
||||
/// token missing/invalid), and any I/O error from writing the PR
|
||||
/// URL to stdout.
|
||||
pub fn run(client: &Client, args: Args) -> Result<()> {
|
||||
let body = body::resolve(args.body.as_deref(), args.body_file.as_deref())?.unwrap_or_default();
|
||||
if args.push {
|
||||
|
|
|
|||
Loading…
Reference in a new issue