Added better documentation for the return value of handle_response

flowr-analysis · Sep 5, 2024 · acfbe6c · acfbe6c
1 parent b8d2be3
commit acfbe6c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/R/utils.R b/R/utils.R
@@ -40,6 +40,14 @@ get_filetoken <- function(filepath = rlang::missing_arg(), content = rlang::miss
 #' @param res The response to handle
 #'
 #' @return A list with either the error's reason or the complete response
+#' \describe{
+#'   \item{id}{The ID of the response (only in case of success).}
+#'   \item{res}{The complete response object (only in case of success).}
+#' }
+#' or
+#' \describe{
+#'   \item{error}{The reason for the error (only present in case of an error).}
+#' }
 #'
 #' @seealso [send_request()]
 handle_response <- function(res) {

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