spell out success and failure response for proof_cancel

getwilds · Jan 26, 2024 · 1c069c8 · 1c069c8
1 parent 669972c
commit 1c069c8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/R/cancel.R b/R/cancel.R
@@ -3,8 +3,10 @@
 #' @export
 #' @references <https://github.com/FredHutch/proof-api#delete-cromwell-server>
 #' @inheritSection proof_status Timeout
-#' @return A list with a single field:
+#' @return On success, a list with a single field:
 #' - `message` (character)
+#'
+#' If run when there's no Cromwell server running, an HTTP error
 proof_cancel <- function() {
   response <- DELETE(
     make_url("cromwell-server"),

diff --git a/man/proof_cancel.Rd b/man/proof_cancel.Rd