r-lib / lintr

Static Code Analysis for R
https://lintr.r-lib.org
Other
1.18k stars 184 forks source link

linter to ensure roxygen documentation for all functions #1975

Open luma-sb opened 1 year ago

luma-sb commented 1 year ago

I have been searching around for an existing linter that might offer this, but to no avail.

New functions are written with roxygen documentation missing and lintr doesn't appear to be flagging this up during our CI.

We're currently using the default set of linters.

Valid feature request? Or have I perhaps missed something?

AshesITR commented 1 year ago

Just to be clear, do you want to check that all functions have roxygen-style comments in the code immediately preceding them? Or just for exported functions?

That could probably be done.

luma-sb commented 1 year ago

💯 All functions