Skip to content

Commit

Permalink
add examples for jobs functions
Browse files Browse the repository at this point in the history
  • Loading branch information
toph-allen committed Dec 31, 2024
1 parent 95c178e commit 5655e57
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 0 deletions.
24 changes: 24 additions & 0 deletions R/content.R
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,13 @@ content_ensure <- function(
#' @note
#' 1. On Connect instances earlier than 2022.10.0, these columns will contain `NA` values.
#'
#' @examples
#' \dontrun{
#' client <- connect()
#' item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
#' jobs <- get_jobs(item)
#' }
#'
#' @family job functions
#' @family content functions
#' @export
Expand Down Expand Up @@ -718,6 +725,13 @@ get_job <- function(content, key) {
#' Note that `app_id`, `app_guid`, `job_id`, and `result` are `NA` if the
#' request returns an error.
#'
#' @examples
#' \dontrun{
#' client <- connect()
#' item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
#' result <- terminate_jobs(item)
#' }
#'
#' @family job functions
#' @family content functions
#' @export
Expand Down Expand Up @@ -760,6 +774,16 @@ terminate_jobs <- function(content, keys = NULL) {
#' - `timestamp`: The time of the entry.
#' - `data`: The logged text.
#'
#' @examples
#' \dontrun{
#' client <- connect()
#' item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
#' jobs <- get_jobs(item)
#' key <- jobs$key[1]
#' log <- get_job_log(item, key)
#' }
#'
#'
#' @family job functions
#' @family content functions
#' @export
Expand Down
11 changes: 11 additions & 0 deletions man/get_job_log.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions man/get_jobs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions man/terminate_jobs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5655e57

Please sign in to comment.