usethis icon indicating copy to clipboard operation
usethis copied to clipboard

Could the manual page of use_upkeep_issue show the checklist?

Open maelle opened this issue 2 years ago • 2 comments

I'd find it nice to see the list of items in the function documentation, without having to open an issue. My use case would be to send the page link to potential users, being confident they'd get a good idea of what the good practice list could look like.

In any case, thanks for a very useful function. :smile_cat:

maelle avatar Jun 16 '23 10:06 maelle

Yeah, it should! We should do the same for use_release_issue() too.

hadley avatar Nov 03 '23 15:11 hadley

I tried doing this for release issue, but ran into an issue (potentially roxygen2 issue?)

in the docs, I added (Line 27 in release.R)


#' ## Built-in bullets
#'
#' ```{r, results = "asis", echo = FALSE, message = FALSE, warning = FALSE}
#' bullets <- release_checklist(version = "1.0.0", on_cran = TRUE)
#' cat(bullets, sep = "\n")
#' ```
#'

Works pretty well, but there is output at the bottom I can't get rid of

image

olivroy avatar Jul 04 '24 14:07 olivroy