Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

linter to ensure roxygen documentation for all functions #1975

Open
luma-sb opened this issue Jun 9, 2023 · 2 comments
Open

linter to ensure roxygen documentation for all functions #1975

luma-sb opened this issue Jun 9, 2023 · 2 comments
Labels
new-linter roxygen2 Linting package documentation

Comments

@luma-sb
Copy link

luma-sb commented Jun 9, 2023

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
Copy link
Collaborator

AshesITR commented Jun 9, 2023

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
Copy link
Author

luma-sb commented Jun 9, 2023

💯 All functions

@MichaelChirico MichaelChirico added the roxygen2 Linting package documentation label Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-linter roxygen2 Linting package documentation
Projects
None yet
Development

No branches or pull requests

3 participants