From c3facbf48ab87a570a7c254cf65ac8bfe7a8752f Mon Sep 17 00:00:00 2001 From: Christine Stawitz Date: Wed, 13 Jul 2022 17:04:17 -0700 Subject: [PATCH] update with an example --- R/get_issues.R | 7 +++++++ man/get_issues.Rd | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/R/get_issues.R b/R/get_issues.R index 6fa5ee9..f7acde3 100644 --- a/R/get_issues.R +++ b/R/get_issues.R @@ -10,6 +10,13 @@ #' @param secret_ The secret corresponding to the key. #' @param repo_name The name of the repository #' @return A \code{json} list of returned issues from Github. +#' @examples +#' \dontrun{ +#' get_issues(appname_ = "github", +#' key_ = "56b637a5baffac62cad9", +#' secret_ = "8e107541ae1791259e9987d544ca568633da2ebf", +#' repo_name = "r-lib/httr") +#' } #' @export get_issues <- function(appname_, key_, secret_, repo_name) { diff --git a/man/get_issues.Rd b/man/get_issues.Rd index c3f2c63..630276f 100644 --- a/man/get_issues.Rd +++ b/man/get_issues.Rd @@ -24,3 +24,9 @@ key, the corresponding secret, the organization and repo name, and uses the Github api and \code{httr} package to query the API for the issues in that repository. } +\examples{ +get_issues(appname_ = "github", +key_ = "56b637a5baffac62cad9", +secret_ = "8e107541ae1791259e9987d544ca568633da2ebf", +repo_name = "r-lib/httr") +}