Skip to content

Commit f836c93

Browse files
committed
More documentation polishing
1 parent b19df14 commit f836c93

3 files changed

Lines changed: 18 additions & 33 deletions

File tree

R/release.R

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
#' `r lifecycle::badge("deprecated")`
55
#'
66
#' `release()` is deprecated in favour of [usethis::use_release_issue()].
7-
#' We no longer feel confident recommrding `release()` because we don't use it
7+
#' We no longer feel confident recommending `release()` because we don't use it
88
#' ourselves, so there's no guarantee that it will track best practices as
99
#' they evolve over time.
1010
#'
11+
#' If you want to programmatical submit to CRAN, you can continue to use
12+
#' [submit_cran()].
13+
#'
1114
#' @template devtools
1215
#' @param check if `TRUE`, run checking, otherwise omit it. This
1316
#' is useful if you've just checked your package and you're ready to
@@ -228,23 +231,13 @@ cran_submission_url <- "https://xmpalantir.wu.ac.at/cransubmit/index2.php"
228231
#' Submit a package to CRAN
229232
#'
230233
#' @description
231-
232234
#' This submits your package to CRAN using the web-form submission process.
233-
#' After submission, you will receive an email asking you to confirm submission
234-
#' - this is used to check that the package is submitted by the maintainer.
235-
#'
236-
#' You may prefer to use `submit_cran()` indirectly, by calling [release()]
237-
#' instead. `release()` performs many checks verifying that your package is
238-
#' indeed ready for CRAN, before eventually asking for your confirmation that
239-
#' you'd like to submit it to CRAN (which it does by calling `submit_cran()`).
235+
#' To complete the submission you will need respond to the email sent to the
236+
#' maintainer email address.
240237
#'
241-
#' Whether to use `release()` or `submit_cran()` depends on the rest of your
242-
#' development process. If you want to be super cautious, use `release()`, even
243-
#' though it may be redundant with other checks you have performed. On the other
244-
#' hand, if you have many other checks in place (such as automated checks via
245-
#' GitHub Actions and the task list generated by
246-
#' [usethis::use_release_issue()]), it makes sense to use `submit_cran()`
247-
#' directly.
238+
#' We generally recommend using this part of the process defined by
239+
#' [use_release_issue()]; this process maximizes the chances of a successful
240+
#' submission.
248241
#'
249242
#' @template devtools
250243
#' @inheritParams release

man/release.Rd

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/submit_cran.Rd

Lines changed: 5 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)