This follows up on a discussion on Mastodon: https://mastodon.social/@Lluis_Revilla@fosstodon.org/116622294667214252 (cc @llrs).
A common reason for rejection during the first CRAN submission is some functions missing examples and documented return values.
The release issue already specifies that one should check this at the first submission:
|
todo( |
|
"Check that all exported functions have `@return` and `@examples`" |
|
), |
But speaking from experience, it easily happens to still think you're good to go and be incorrect. It would be good to give users a way to actually check they have done everything correctly.
Would it make sense to edit this bullet to point to devtools::check_doc_fields()?
This follows up on a discussion on Mastodon: https://mastodon.social/@Lluis_Revilla@fosstodon.org/116622294667214252 (cc @llrs).
A common reason for rejection during the first CRAN submission is some functions missing examples and documented return values.
The release issue already specifies that one should check this at the first submission:
usethis/R/release.R
Lines 93 to 95 in 7fa2107
But speaking from experience, it easily happens to still think you're good to go and be incorrect. It would be good to give users a way to actually check they have done everything correctly.
Would it make sense to edit this bullet to point to
devtools::check_doc_fields()?