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.

Sign up for GitHub

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

RobertASmith opened this issue Aug 30, 2024 · 0 comments

Assignees

Labels

Contributor

RobertASmith commented Aug 30, 2024 •

edited

Loading

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 mentioned this issue

Release assertHE 0.1.0 #98

Open

26 tasks

RobertASmith assigned Smit-tay and RobertASmith

RobertASmith added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment