From 5618ed946cf4440cc7fbb414f614b5839ae2498d Mon Sep 17 00:00:00 2001 From: ChristineStawitz-NOAA Date: Tue, 7 Nov 2023 23:01:39 +0000 Subject: [PATCH] Docs: run devtools::document() --- DESCRIPTION | 2 +- man/get_issues.Rd | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 114238c..fc7470f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,7 +7,7 @@ Description: This uses an API key to retrieve information about pull requests an License: GPL (>= 3) | file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.0 +RoxygenNote: 7.2.3 Imports: blastula, dplyr, diff --git a/man/get_issues.Rd b/man/get_issues.Rd index 630276f..3755583 100644 --- a/man/get_issues.Rd +++ b/man/get_issues.Rd @@ -4,7 +4,7 @@ \alias{get_issues} \title{Query the Github API} \usage{ -get_issues(appname_, key_, secret_, repo_name) +get_issues(appname_, key_, secret_, repo_name, type = "issues") } \arguments{ \item{appname_}{The name of the application you have authorized on Github.} @@ -14,6 +14,8 @@ get_issues(appname_, key_, secret_, repo_name) \item{secret_}{The secret corresponding to the key.} \item{repo_name}{The name of the repository} + +\item{type}{The API endpoint you are querying} } \value{ A \code{json} list of returned issues from Github. @@ -25,8 +27,10 @@ the Github api and \code{httr} package to query the API for the issues in that repository. } \examples{ +\dontrun{ get_issues(appname_ = "github", key_ = "56b637a5baffac62cad9", secret_ = "8e107541ae1791259e9987d544ca568633da2ebf", repo_name = "r-lib/httr") } +}