Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 986d28b

Browse files
committed
update roxygen2 and document, fixing some roxygen2 complaints
1 parent 6111dfb commit 986d28b

File tree

5 files changed

+30
-22
lines changed

5 files changed

+30
-22
lines changed

DESCRIPTION

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Description: Work with 'GitHub' 'gists' from 'R' (e.g.,
1212
<https://gist.github.com/>.
1313
Version: 0.9.0.93
1414
Authors@R: c(
15-
person("Scott", "Chamberlain", role = c("aut", "cre"),
16-
email = "[email protected]",
17-
comment = c(ORCID="0000-0003-1444-9135")),
15+
person("Scott", "Chamberlain", , "[email protected]", role = c("aut", "cre"),
16+
comment = c(ORCID = "0000-0003-1444-9135")),
1817
person("Ramnath", "Vaidyanathan", role = "aut"),
1918
person("Karthik", "Ram", role = "aut"),
20-
person("Milgram", "Eric", role = "aut")
19+
person("Milgram", "Eric", role = "aut"),
20+
person("Eric R.", "Scott", role = "ctb")
2121
)
2222
License: MIT + file LICENSE
2323
URL: https://github.com/ropensci/gistr (devel),
@@ -40,7 +40,7 @@ Imports:
4040
Suggests:
4141
git2r,
4242
testthat
43-
RoxygenNote: 7.1.1
43+
RoxygenNote: 7.3.2
4444
X-schema.org-applicationCategory: Web
4545
X-schema.org-keywords: http, https, API, web-services, GitHub, GitHub API, gist, gists, code, script, snippet
4646
X-schema.org-isPartOf: https://ropensci.org

R/gist_auth.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
#'
66
#' There are two ways to authorise gistr to work with your GitHub account:
77
#'
8-
#' - Generate a personal access token with the gist scope selected, and set it
9-
#' as the `GITHUB_PAT` environment variable per session using `Sys.setenv`
10-
#' or across sessions by adding it to your `.Renviron` file or similar.
11-
#' See
8+
#' - Generate a personal access token with the gist scope selected, and store it
9+
#' with `gitcreds::gitcreds_set()`. Alternatively you can set it as the
10+
#' `GITHUB_PAT` environment variable per session using `Sys.setenv()` or across
11+
#' sessions by adding it to your `.Renviron` file or similar. See
1212
#' https://help.github.com/articles/creating-an-access-token-for-command-line-use
13-
#' for help
14-
#' - Interactively login into your GitHub account and authorise with OAuth.
13+
#' for help or use `usethis::create_github_token()`.
14+
#' - Interactively log in into your GitHub account and authorise with OAuth.
1515
#'
16-
#' Using `GITHUB_PAT` is recommended.
16+
#' Using `gitcreds::gitcreds_set()` is recommended.
1717
#'
1818
#' @export
1919
#' @param app An [httr::oauth_app()] for GitHub. The default uses an

R/gistr-package.R

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@
2222
#' @importFrom jsonlite fromJSON flatten
2323
#' @name gistr-package
2424
#' @aliases gistr
25-
#' @docType package
2625
#' @title R client for GitHub gists
2726
#' @author Scott Chamberlain \email{myrmecocystus@@gmail.com}
2827
#' @author Ramnath Vaidyanathan \email{ramnath.vaidya@@gmail.com}
2928
#' @author Karthik Ram \email{karthik.ram@@gmail.com}
3029
#' @keywords package
31-
NULL
30+
"_PACKAGE"
3231

3332
#' @title Create gists
3433
#'
@@ -43,7 +42,7 @@ NULL
4342
#' - [gist_create_git()] - Create gists from files or code
4443
#' blocks, using git. Because this function uses git, you have more
4544
#' flexibility than with the above function: you can include any binary files,
46-
#' and can easily upload all artifacts.
45+
#' and can easily upload all artifacts.
4746
#' - [gist_create_obj()] - Create gists from R objects: data.frame, list,
4847
#' character string, matrix, or numeric. Uses the GitHub HTTP API.
4948
#'

man/gist_auth.Rd

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/gistr-package.Rd

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)