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

Check that all exported functions have @return and @examples #99

Open
Tracked by #98
RobertASmith opened this issue Aug 30, 2024 · 0 comments
Open
Tracked by #98

Check that all exported functions have @return and @examples #99

RobertASmith opened this issue Aug 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@RobertASmith
Copy link
Contributor

RobertASmith commented Aug 30, 2024

So this is the one thing that I think will take a bit of time.

  • Every function with an @export tag needs to have a @return included in the roxygen above. I think most if not all do but we need to check.
  • Every function should have an example unless there is a good reason why an example won't work. So far I've been lazy and used lots of dontrun statements so the examples were not executed. More on this here
  • I've started this process here
@RobertASmith RobertASmith added the documentation Improvements or additions to documentation label Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants