search

HenrikBengtsson / matrixStats

R package: Methods that Apply to Rows and Columns of Matrices (and to Vectors)
https://cran.r-project.org/package=matrixStats
206 stars 34 forks source link

R CMD check NOTE: Documented arguments not in \usage in documentation ... #237

Closed HenrikBengtsson closed 1 year ago

HenrikBengtsson commented 1 year ago 
Version: 1.0.0
Check: Rd \usage sections
Result: NOTE
    Documented arguments not in \usage in documentation object ‘x_OP_y’:
     ‘idxs’

    Functions with \usage entries need to have the appropriate \alias
    entries, and all their arguments documented.
    The \usage entries must correspond to syntactically valid R code.
    See chapter ‘Writing R documentation files’ in the ‘Writing R
    Extensions’ manual.
Flavor: [r-devel-linux-x86_64-debian-gcc](https://www.r-project.org/nosvn/R.check/r-devel-linux-x86_64-debian-gcc/matrixStats-00check.html)
yaccos commented 1 year ago

The problem here seems to be that the argument is named idxs in the documentation, while in the real function, the argument is named yidxs.