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

testex::use_testex_as_testthat() automatic re-documentation? #10

Closed
dgkf opened this issue Apr 9, 2024 · 0 comments · Fixed by #11
Closed

testex::use_testex_as_testthat() automatic re-documentation? #10

dgkf opened this issue Apr 9, 2024 · 0 comments · Fixed by #11
Milestone

Comments

@dgkf
Copy link
Owner

dgkf commented Apr 9, 2024

Should documentation automatically be generated when testex is run as testthat?

Without re-documenting, there's a risk that tests have been changed, but wouldn't yet be reflected. This is expected if someone is mindful about how testex works, but this is probably not a safe assumption and should probably "just work" in most cases.

Other user-facing behavior ideas:

  • Should it rebuild if roxygen2 version is different?
  • Should it be configurable? Parameter? DESCRIPTION option?
  • Should it overwrite package docs, or just build in a temp folder? Maybe emit a warning if documentation is out of date?
@dgkf dgkf added this to the v0.2.0 milestone Apr 14, 2024
@dgkf dgkf mentioned this issue Apr 14, 2024
@dgkf dgkf closed this as completed in #11 Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant