From 2487fc90192139700cb90e5e523da9fd65f730cd Mon Sep 17 00:00:00 2001 From: Dave Slager Date: Sun, 25 Feb 2024 18:39:22 -0800 Subject: [PATCH] repress new R CMD check notes from R-devel --- R/config.R | 2 +- R/scrape_authorship.R | 2 +- R/write_validation_report.R | 2 +- man/scraping.Rd | 2 +- man/validation_config.Rd | 2 +- man/vt_use_report.Rd | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/config.R b/R/config.R index fd10f867..3085ae6d 100644 --- a/R/config.R +++ b/R/config.R @@ -16,7 +16,7 @@ #' of the naming structure of the output validation report. use `{package}` #' for package name, `{version}` to record package version, and `{date}` to #' capture the date the report was run. -#' @param username_list list of user objects created by {make_user}. Each user +#' @param username_list list of user objects created by make_user. Each user #' contains entries for username, name, title, and role to be used for #' documentation. #' @param validation_files list of validation files: requirements, test cases and test code. diff --git a/R/scrape_authorship.R b/R/scrape_authorship.R index 9232ad3f..f5a12808 100644 --- a/R/scrape_authorship.R +++ b/R/scrape_authorship.R @@ -115,7 +115,7 @@ vt_scrape_test_code_editors <- function(tags = c("editor", "editDate", "deprecat out } -#' @note vt_scrape_functions Requires access to raw R/ or function documentation parsed via {valtools} into validation/ folder. +#' @note vt_scrape_functions Requires access to raw R/ or function documentation parsed via valtools into validation/ folder. #' Cannot pull information from installed R/ location. #' @export #' @rdname scraping diff --git a/R/write_validation_report.R b/R/write_validation_report.R index 934eae83..f24244c8 100644 --- a/R/write_validation_report.R +++ b/R/write_validation_report.R @@ -1,6 +1,6 @@ #' Create validation report from template #' @param pkg_name name of package -#' @param template what validation report template from {valtools} to use, +#' @param template what validation report template from valtools to use, #' one of "validation" (default) or "requirements" #' @param dynamic_referencing Should dynamic referencing be enabled by default. Boolean defaults to FALSE. #' @param open boolean to open the validation report for further editing diff --git a/man/scraping.Rd b/man/scraping.Rd index 3a245cc1..e7ce9e93 100644 --- a/man/scraping.Rd +++ b/man/scraping.Rd @@ -72,7 +72,7 @@ opinionated kable formatting functions are provided as well to facilitate nice printing in the reports. } \note{ -vt_scrape_functions Requires access to raw R/ or function documentation parsed via {valtools} into validation/ folder. +vt_scrape_functions Requires access to raw R/ or function documentation parsed via valtools into validation/ folder. Cannot pull information from installed R/ location. } \examples{ diff --git a/man/validation_config.Rd b/man/validation_config.Rd index 8e4fd29e..edb1f919 100644 --- a/man/validation_config.Rd +++ b/man/validation_config.Rd @@ -69,7 +69,7 @@ of the naming structure of the output validation report. use \code{{package}} for package name, \code{{version}} to record package version, and \code{{date}} to capture the date the report was run.} -\item{username_list}{list of user objects created by {make_user}. Each user +\item{username_list}{list of user objects created by make_user. Each user contains entries for username, name, title, and role to be used for documentation.} diff --git a/man/vt_use_report.Rd b/man/vt_use_report.Rd index de18cec1..e145086e 100644 --- a/man/vt_use_report.Rd +++ b/man/vt_use_report.Rd @@ -14,7 +14,7 @@ vt_use_report( \arguments{ \item{pkg_name}{name of package} -\item{template}{what validation report template from {valtools} to use, +\item{template}{what validation report template from valtools to use, one of "validation" (default) or "requirements"} \item{dynamic_referencing}{Should dynamic referencing be enabled by default. Boolean defaults to FALSE.}