Skip to content

Commit

Permalink
Merge branch 'r-lib:main' into tidy_unzip_directory
Browse files Browse the repository at this point in the history
  • Loading branch information
burnsal authored Mar 26, 2024
2 parents 8b04032 + 9e64daf commit 00d9e63
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 3 deletions.
4 changes: 4 additions & 0 deletions R/documentation.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@
#' @export
use_package_doc <- function(open = rlang::is_interactive()) {
check_is_package("use_package_doc()")
use_directory("R")
use_template(
"packagename-package.R",
package_doc_path(),
open = open
)
ui_bullets(c(
"_" = "Run {.run devtools::document()} to update package-level documentation."
))
}

package_doc_path <- function() {
Expand Down
2 changes: 1 addition & 1 deletion R/roxygen.R
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ use_roxygen_md <- function(overwrite = FALSE) {
the conversion process."
))
}
ui_bullets(c("v" = "Run {.run devtools::document()} when you're done."))
ui_bullets(c("_" = "Run {.run devtools::document()} when you're done."))

return(invisible())
}
Expand Down
2 changes: 1 addition & 1 deletion R/tibble.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#' * Prepare the roxygen directive necessary to import at least one function
#' from tibble:
#' - If possible, the directive is inserted into existing package-level
#' documentation, i.e. the roxygen snippet created by [use_package_doc()]
#' documentation, i.e. the roxygen snippet created by [use_package_doc()]
#' - Otherwise, we issue advice on where the user should add the directive
#'
#' This is necessary when your package returns a stored data object that has
Expand Down
2 changes: 1 addition & 1 deletion man/use_tibble.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tests/testthat/_snaps/roxygen.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
use_package_doc()
Message
v Writing 'R/{TESTPKG}-package.R'.
[ ] Run `devtools::document()` to update package-level documentation.

---

Expand Down

0 comments on commit 00d9e63

Please sign in to comment.