Documentation: par_is_documented

[schneiderpy]

Here is a new issue, which is not documented (however, the 'autotest' message is pretty straight forward)

I get the warning message that the usage of the param 'digits' is not documented with an example:

warning | par_is_demonstrated | concstats_dom | digits |   | Check that parameter usage is demonstrated | Examples do not demonstrate usage of this parameter | true -- | -- | -- | -- | -- | -- | -- | --

However, here's the documentation ...

#' @title Dominance Index
#' @srrstats {G1.4} roxygen2 used to document functions
#' @description
#' An alternative measure which can be used in case of mergers.
#'
#' @param x A non-negative numeric vector.
#' @param na.rm A logical vector that indicates whether \code{NA} values should
#' be excluded or not. Must be either \code{TRUE} or \code{FALSE}. The default
#' is \code{TRUE}. If set to \code{FALSE} the computation yields a message
#' if the vector contains \code{NA} values. NAs will be removed for further
#' computations.
#' @param digits An optional value for digits. Specifies the minimum number of
#' significant digits to be printed in values. The default is \code{NULL} and
#' will use base R print option. Significant digits defaults to 7. Values are
#' restricted between 1 and default value.
#' @details
#' \code{concstats_dom} calculates a dominance index, which measures the
#' concentration within the Herfindahl-Hirschman index, that is, the
#' concentration within the concentration.
#' @return A single numeric measure in decimal form.
#' @srrstats {G1.0} Primary reference
#' @srrstats {G1.1} First implementation in R
#' @references Garcia Alba Idunate, P. (1994). "Un Indice de dominancia para el
#' analisis de la estructura de los mercados". \emph{El Trimestre Economico},
#' 61: 499-524.
#'
#' @family Competition/Concentration measures
#' @Rdname concstats_dom
#' @examples
#' # a vector of market shares
#' x <- c(0.35, 0.4, 0.05, 0.1, 0.06, 0.04)
#' concstats_dom(x, na.rm = FALSE, digits = 2)
#'
#' # a vector with NA values
#' x <- c(0.4, 0.2, 0.25, 0.1, 0.05, NA)
#' concstats_dom(x)

I have no idea how to document the usage in a different way ...

[mpadge]

I really need concrete examples to be able to progress further. What you've pasted there seems perfectly fine, and should not trigger that error. Can you provide a link to the code/repo which produces this error please? thanks