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

Could the manual page of use_upkeep_issue show the checklist? #1862

Open
maelle opened this issue Jun 16, 2023 · 2 comments
Open

Could the manual page of use_upkeep_issue show the checklist? #1862

maelle opened this issue Jun 16, 2023 · 2 comments
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day

Comments

@maelle
Copy link
Contributor

maelle commented Jun 16, 2023

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. 😸

@hadley
Copy link
Member

hadley commented Nov 3, 2023

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

@olivroy
Copy link
Contributor

olivroy commented Jul 4, 2024

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

@jennybc jennybc added the tidy-dev-day 🤓 Tidyverse Developer Day label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day
Projects
None yet
Development

No branches or pull requests

4 participants