From 92cc6ad9bc67ef1b27522d8eee5c2803e13c8158 Mon Sep 17 00:00:00 2001 From: Leonidas Zhak <70497898+LeonidasZhak@users.noreply.github.com> Date: Sun, 7 Jun 2026 02:43:12 +0800 Subject: [PATCH] docs: fix malformed Rd syntax in @param k description Fix double backtick (`integer`` -> `integer`) in sum_run's @param k roxygen comment that produced broken \verb{} output in sum_run.Rd and mean_run.Rd (which inherits from sum_run via @inheritParams). Before: \verb{integer`` vector or single value)...} After: \code{integer} vector or single value) --- DESCRIPTION | 2 +- R/RcppExports.R | 2 +- man/mean_run.Rd | 4 +++- man/runner.Rd | 4 ++-- man/sum_run.Rd | 4 +++- src/runner.cpp | 2 +- 6 files changed, 11 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3d9f728..287712d 100755 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -25,6 +25,6 @@ Suggests: knitr, rmarkdown, tinytest -RoxygenNote: 7.3.3 Roxygen: list(markdown = TRUE) VignetteBuilder: knitr +Config/roxygen2/version: 8.0.0 diff --git a/R/RcppExports.R b/R/RcppExports.R index 3504261..3dc629c 100644 --- a/R/RcppExports.R +++ b/R/RcppExports.R @@ -75,7 +75,7 @@ minmax_run <- function(x, metric = "min", na_rm = TRUE) { #' #' @param x `numeric` vector which running function is calculated on #' -#' @param k (`integer`` vector or single value)\cr +#' @param k (`integer` vector or single value)\cr #' Denoting size of the running window. If `k` is a single value then window #' size is constant for all elements, otherwise if `length(k) == length(x)` #' different window size for each element. diff --git a/man/mean_run.Rd b/man/mean_run.Rd index be3d288..776f98e 100755 --- a/man/mean_run.Rd +++ b/man/mean_run.Rd @@ -17,7 +17,9 @@ mean_run( \arguments{ \item{x}{\code{numeric} vector which running function is calculated on} -\item{k}{(\verb{integer`` vector or single value)\\cr Denoting size of the running window. If }k\verb{is a single value then window size is constant for all elements, otherwise if}length(k) == length(x)` +\item{k}{(\code{integer} vector or single value)\cr +Denoting size of the running window. If \code{k} is a single value then window +size is constant for all elements, otherwise if \code{length(k) == length(x)} different window size for each element.} \item{lag}{(\code{integer} vector or single value)\cr diff --git a/man/runner.Rd b/man/runner.Rd index 2d58d89..f770ff3 100644 --- a/man/runner.Rd +++ b/man/runner.Rd @@ -115,7 +115,7 @@ generates a regular sequence over the range of \code{idx}.} If \code{TRUE}, return \code{NA} for windows that extend beyond the data range.} \item{simplify}{(\code{logical} or \code{character})\cr -Simplify result like \code{\link[base:lapply]{base::sapply()}}. \code{TRUE} returns vector/matrix, +Simplify result like \code{\link[base:sapply]{base::sapply()}}. \code{TRUE} returns vector/matrix, \code{"array"} may return a higher-dimensional array.} \item{cl}{(\code{cluster}) \emph{experimental}\cr @@ -276,7 +276,7 @@ and shifts at each position. Pass a \code{\link[parallel:makeCluster]{parallel::makeCluster()}} object via \code{cl} to run windows in parallel. Objects referenced inside \code{f} (other than its arguments) must -be exported with \code{\link[parallel:clusterApply]{parallel::clusterExport()}} beforehand. Parallel +be exported with \code{\link[parallel:clusterExport]{parallel::clusterExport()}} beforehand. Parallel execution adds overhead and is only beneficial for expensive computations. } } diff --git a/man/sum_run.Rd b/man/sum_run.Rd index b2267da..e45c2fb 100755 --- a/man/sum_run.Rd +++ b/man/sum_run.Rd @@ -17,7 +17,9 @@ sum_run( \arguments{ \item{x}{\code{numeric} vector which running function is calculated on} -\item{k}{(\verb{integer`` vector or single value)\\cr Denoting size of the running window. If }k\verb{is a single value then window size is constant for all elements, otherwise if}length(k) == length(x)` +\item{k}{(\code{integer} vector or single value)\cr +Denoting size of the running window. If \code{k} is a single value then window +size is constant for all elements, otherwise if \code{length(k) == length(x)} different window size for each element.} \item{lag}{(\code{integer} vector or single value)\cr diff --git a/src/runner.cpp b/src/runner.cpp index ba30782..b598c87 100755 --- a/src/runner.cpp +++ b/src/runner.cpp @@ -780,7 +780,7 @@ runner_vec(Rcpp::Vector const &x, //' //' @param x `numeric` vector which running function is calculated on //' -//' @param k (`integer`` vector or single value)\cr +//' @param k (`integer` vector or single value)\cr //' Denoting size of the running window. If `k` is a single value then window //' size is constant for all elements, otherwise if `length(k) == length(x)` //' different window size for each element.