docs(script): improve doc comment

This commit is contained in:
Jake Stanger 2022-11-06 22:53:29 +00:00
parent 58d55db660
commit c48029664d
No known key found for this signature in database
GPG Key ID: C51FC8F9CB0BEA61

View File

@ -3,7 +3,8 @@ use color_eyre::{Help, Report, Result};
use std::process::Command;
use tracing::instrument;
/// Attempts to execute a given command.
/// Attempts to execute a given command,
/// waiting for it to finish.
/// If the command returns status 0,
/// the `stdout` is returned.
/// Otherwise, an `Err` variant