Skip to content

Commit

Permalink
doc: adding ` to package names in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ColinFay committed Aug 7, 2024
1 parent 70c5946 commit bb33735
Show file tree
Hide file tree
Showing 12 changed files with 41 additions and 29 deletions.
23 changes: 16 additions & 7 deletions R/addins.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
#' The series of `go_to_*()` addins help you go to
#' common files used in developing a `{golem}` application.
#'
#' @param wd The working directory of the `{golem}` application.
#'
#' @importFrom attempt stop_if_not
#'
#' @aliases addins
Expand Down Expand Up @@ -62,7 +64,8 @@ go_to <- function(
#' @rdname addins
#' @aliases addins
go_to_start <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"dev/01_start.R",
wd = wd
Expand All @@ -71,7 +74,8 @@ go_to_start <- function(
#' @rdname addins
#' @aliases addins
go_to_dev <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"dev/02_dev.R",
wd = wd
Expand All @@ -80,7 +84,8 @@ go_to_dev <- function(
#' @rdname addins
#' @aliases addins
go_to_deploy <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"dev/03_deploy.R",
wd = wd
Expand All @@ -89,7 +94,8 @@ go_to_deploy <- function(
#' @rdname addins
#' @aliases addins
go_to_run_dev <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"dev/run_dev.R",
wd = wd
Expand All @@ -98,7 +104,8 @@ go_to_run_dev <- function(
#' @rdname addins
#' @aliases addins
go_to_app_ui <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"R/app_ui.R",
wd = wd
Expand All @@ -107,7 +114,8 @@ go_to_app_ui <- function(
#' @rdname addins
#' @aliases addins
go_to_app_server <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"R/app_server.R",
wd = wd
Expand All @@ -116,7 +124,8 @@ go_to_app_server <- function(
#' @rdname addins
#' @aliases addins
go_to_run_app <- function(
wd = golem::get_golem_wd()) {
wd = golem::get_golem_wd()
) {
go_to(
"R/run_app.R",
wd = wd
Expand Down
4 changes: 2 additions & 2 deletions R/create_golem.R
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ here_set_here <- function(...){
#' correct according to CRAN requirements.
#' @param open Boolean. Open the created project?
#' @param overwrite Boolean. Should the already existing project be overwritten ?
#' @param package_name Package name to use. By default, {golem} uses
#' @param package_name Package name to use. By default, `{golem}` uses
#' `basename(path)`. If `path == '.'` & `package_name` is
#' not explicitly set, then `basename(getwd())` will be used.
#' @param without_comments Boolean. Start project without golem comments
#' @param without_comments Boolean. Start project without `{golem}` comments
#' @param project_hook A function executed as a hook after project
#' creation. Can be used to change the default `{golem}` structure.
#' to override the files and content. This function is executed just
Expand Down
4 changes: 2 additions & 2 deletions R/get_sysreqs.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Now in {dockerfiler}
# Now in `{dockerfiler}`

#' Get system requirements (Deprecated)
#'
#' This function retrieves information about the
#' system requirements using the <https://sysreqs.r-hub.io>
#' API. This function is now deprecated, and was moved to
#' {dockerfiler}.
#' `{dockerfiler}`.
#'
#' @param packages character vector. Packages names.
#' @param batch_n numeric. Number of simultaneous packages to ask.
Expand Down
6 changes: 3 additions & 3 deletions R/install_dev_deps.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' Install {golem} dev dependencies
#' Install `{golem}` dev dependencies
#'
#' This function will run rlang::check_installed() on:
#' + {usethis}
Expand Down Expand Up @@ -65,8 +65,8 @@ install_dev_deps <- function(
if (missing(dev_deps)){
dev_deps <- getFromNamespace("dev_deps", "golem")
}


for (
pak in dev_deps
) {
Expand Down
2 changes: 1 addition & 1 deletion R/set_golem_options.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#' @param talkative Should the messages be printed to the console?
#' @param name The name of the app
#' @param version The version of the app
#' @param config_file path to the {golem} config file
#' @param config_file path to the `{golem}` config file
#' @param old_name The old name of the app, used when changing the name
#' @inheritParams config::get
#'
Expand Down
17 changes: 10 additions & 7 deletions man/addins.Rd

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

4 changes: 2 additions & 2 deletions man/create_golem.Rd

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

2 changes: 1 addition & 1 deletion man/get_sysreqs.Rd

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

2 changes: 1 addition & 1 deletion man/golem_opts.Rd

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

2 changes: 1 addition & 1 deletion man/install_dev_deps.Rd

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

2 changes: 1 addition & 1 deletion man/maintenance_page.Rd

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

2 changes: 1 addition & 1 deletion man/project_hook.Rd

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

0 comments on commit bb33735

Please sign in to comment.