fix(reopen): add # Errors doc to run()
Address argus review on #1938's reopen verb: public fns returning Result need a # Errors doc per the workspace convention. Document the patch_json and print_json failure modes.
This commit is contained in:
parent
11fb2ac0fc
commit
6dcc1cb7e1
1 changed files with 5 additions and 0 deletions
|
|
@ -17,6 +17,11 @@ pub struct Args {
|
||||||
pub(crate) number: u64,
|
pub(crate) number: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// # Errors
|
||||||
|
///
|
||||||
|
/// Returns an error when the `PATCH /repos/{repo}/issues/{number}` request
|
||||||
|
/// fails (network / non-success status from `patch_json`) or when emitting
|
||||||
|
/// the JSON summary via `print_json` fails.
|
||||||
pub fn run(client: &Client, args: Args) -> Result<()> {
|
pub fn run(client: &Client, args: Args) -> Result<()> {
|
||||||
let repo = client.repo();
|
let repo = client.repo();
|
||||||
let resp = client.patch_json(
|
let resp = client.patch_json(
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue