Skip to content

Commit

Permalink
Update docs, fix failing CRAN checks
Browse files Browse the repository at this point in the history
  • Loading branch information
thisisnic committed Feb 19, 2024
1 parent aa96f51 commit 4175000
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 14 deletions.
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Imports:
quanteda,
quanteda.textstats,
rlang,
rmarkdown,
rvest,
stringr,
tools,
Expand All @@ -31,4 +30,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1.9001
RoxygenNote: 7.2.3
2 changes: 1 addition & 1 deletion R/cli.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Parse Vignette Results
#'
#' @param vignette_results Output of calling vignette analysis function
#' @param error_on_failure Raise an error on any negative reviews
#' @param config list containing config settings
#'
#' @keywords internal
vignette_results_display <- function(results, config) {
Expand Down
2 changes: 1 addition & 1 deletion R/function_review.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ check_examples_arity <- function(func, min_arity) {
#' Count failures and warnings for function review
#'
#' @param results Results of function review
#' @param thresholds List of thresholds that result in fails or warnings
#' @param checks List of checks to run
#' @keywords internal
function_get_comments <- function(results, checks) {
comments <- list(fail = 0, warn = 0)
Expand Down
3 changes: 1 addition & 2 deletions R/package_review.R
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ package_review <- function(path = ".", config = get_config()) {
#' Inspired by testthat
#'
#' @param results List of docreview results
#' @param error_on_failure Raise error on review failures?
#' @param error_on_warning Raise error on review warnings?
#' @param config List containing logical values `error_on_warning` and `error_on_failure`
#'
#' @keywords internal
check_results <- function(results, config) {
Expand Down
4 changes: 1 addition & 3 deletions man/check_results.Rd

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

2 changes: 1 addition & 1 deletion man/function_get_comments.Rd

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

4 changes: 2 additions & 2 deletions man/get_config.Rd

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

4 changes: 2 additions & 2 deletions man/vignette_results_display.Rd

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

0 comments on commit 4175000

Please sign in to comment.