From aa25396fd1cff5dd32245dc50b191658aaadeb8c Mon Sep 17 00:00:00 2001 From: Nic Crane Date: Mon, 19 Feb 2024 11:37:58 -0500 Subject: [PATCH] Update docs and bump version --- DESCRIPTION | 2 +- R/cli.R | 2 +- README.Rmd | 2 +- man/vignette_results_display.Rd | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1354505..2fc16fd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: docreview Title: Opinionated Documentation Checking -Version: 0.0.1.9000 +Version: 0.0.2 Authors@R: person(given = "Nic", family = "Crane", diff --git a/R/cli.R b/R/cli.R index 87a70b4..c35e4af 100644 --- a/R/cli.R +++ b/R/cli.R @@ -1,6 +1,6 @@ #' Parse Vignette Results #' -#' @param vignette_results Output of calling vignette analysis function +#' @param results Output of calling vignette analysis function #' @param config list containing config settings #' #' @keywords internal diff --git a/README.Rmd b/README.Rmd index 1f946e1..5668ced 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,7 +18,7 @@ knitr::opts_chunk$set( [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/docreview)](https://cran.r-project.org/package=docreview) [![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![R-CMD-check](https://github.com/thisisnic/docreview/workflows/R-CMD-check/badge.svg)](https://github.com/thisisnic/docreview/actions?query=workflow%3AR-CMD-check) -[![codecov](https://codecov.io/gh/thisisnic/docreview/branch/main/graph/badge.svg)](https://codecov.io/gh/thisisnic/docreview) +[![codecov](https://app.codecov.io/gh/thisisnic/docreview/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thisisnic/docreview) _An opinionated package for enhancing your R package documentation._ diff --git a/man/vignette_results_display.Rd b/man/vignette_results_display.Rd index f423d69..1e94469 100644 --- a/man/vignette_results_display.Rd +++ b/man/vignette_results_display.Rd @@ -7,9 +7,9 @@ vignette_results_display(results, config) } \arguments{ -\item{config}{list containing config settings} +\item{results}{Output of calling vignette analysis function} -\item{vignette_results}{Output of calling vignette analysis function} +\item{config}{list containing config settings} } \description{ Parse Vignette Results