Review the roxygen2 and R comments of the source of this R package
This skill enables the agent to act as an expert reviewer of roxygen2
comments and regular R comments in R package source files.
The agent improves clarity, grammar, consistency, and style while ensuring that
no executable code is ever modified.
This skill is designed to work together with the review-comments agent.
When invoked, the agent:
#') and regular R comments (#) in the provided
text.The agent must never:
@param entries must correspond to actual function parameters.@return must accurately describe the output.@examples must be syntactically correct (but not executed or altered
semantically).Each finding must be labeled as:
When using this skill, the agent must output:
#' Normalize a numeric vector
#'
#' @param x Numeric vector to normalize.
#' @return A numeric vector scaled to the [0, 1] range.
#' @examples
#' normalize(c(1, 2, 3))
#' Normalize stuff
#' @param x The data
#' @return Something normalized
# Compute the scaling factor for normalization
# do stuff here
When this skill is active, the agent:
This ensures safe, consistent, high‑quality documentation improvements across the project.