Skip to content

Commit 520506c

Browse files
authored
Improve documentation (#162)
1 parent 9083fa3 commit 520506c

File tree

6 files changed

+28
-22
lines changed

6 files changed

+28
-22
lines changed

R/render.R

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,14 @@
4141
#' @param profile [Quarto project
4242
#' profile(s)](https://quarto.org/docs/projects/profiles.html) to use. Either
4343
#' a character vector of profile names or `NULL` to use the default profile.
44-
#' @param quarto_args Character vector of other `quarto` CLI flag pass to the
45-
#' command. This is mainly for advanced usage, e.g it can be useful for new
46-
#' options added to quarto CLI and not yet supported as function argument.
47-
#' @param pandoc_args Additional command line options to pass to pandoc.
44+
#' @param quarto_args Character vector of other `quarto` CLI arguments to append
45+
#' to the Quarto command executed by this function. This is mainly intended for
46+
#' advanced usage and useful for CLI arguments which are not yet mirrored in a
47+
#' dedicated parameter of this \R function.
48+
#' @param pandoc_args Additional command line arguments to pass on to Pandoc.
4849
#' @param as_job Render as an RStudio background job. Default is "auto",
4950
#' which will render individual documents normally and projects as
50-
#' background jobs. Use the `quarto.render_as_job` R option to control
51+
#' background jobs. Use the `quarto.render_as_job` \R option to control
5152
#' the default globally.
5253
#'
5354
#' @importFrom rmarkdown relative_to

man/quarto_add_extension.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/quarto_create_project.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/quarto_inspect.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/quarto_render.Rd

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/quarto_use_template.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)