Skip to content

Commit

Permalink
style and docs: run devtools::document() and styler::style_pkg()
Browse files Browse the repository at this point in the history
  • Loading branch information
k-doering-NOAA committed Aug 2, 2024
1 parent 9aebfa3 commit 706d1d3
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
12 changes: 8 additions & 4 deletions R/use_r_workflows.R
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,18 @@ use_calc_coverage <- function(workflow_name = "call-calc-coverage.yml", use_publ
#' }
#' # the same as
#' \dontrun{
#' use_doc_and_style_r(how_to_commit = "pull_request",
#' build_trigger = "push_to_main")
#' use_doc_and_style_r(
#' how_to_commit = "pull_request",
#' build_trigger = "push_to_main"
#' )
#' }
#' # Set up running doc and style on each pull request, commiting directly to
#' # the pull request branch
#' \dontrun{
#' use_doc_and_style_r(how_to_commit = "directly",
#' build_trigger = "pull_request")
#' use_doc_and_style_r(
#' how_to_commit = "directly",
#' build_trigger = "pull_request"
#' )
#' }
#' # Set up the workflow to use a personal access token (PAT)
#' \dontrun{
Expand Down
28 changes: 27 additions & 1 deletion man/use_doc_and_style_r.Rd

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

0 comments on commit 706d1d3

Please sign in to comment.