Improve documentation (#162)

quarto-dev · Mar 7, 2024 · 520506c · 520506c
1 parent 9083fa3
commit 520506c
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 22 deletions.
diff --git a/R/render.R b/R/render.R
@@ -41,13 +41,14 @@
 #' @param profile [Quarto project
 #'   profile(s)](https://quarto.org/docs/projects/profiles.html) to use. Either
 #'   a character vector of profile names or `NULL` to use the default profile.
-#' @param quarto_args Character vector of other `quarto` CLI flag pass to the
-#'   command. This is mainly for advanced usage, e.g it can be useful for new
-#'   options added to quarto CLI and not yet supported as function argument.
-#' @param pandoc_args Additional command line options to pass to pandoc.
+#' @param quarto_args Character vector of other `quarto` CLI arguments to append
+#'   to the Quarto command executed by this function. This is mainly intended for
+#'   advanced usage and useful for CLI arguments which are not yet mirrored in a
+#'   dedicated parameter of this \R function.
+#' @param pandoc_args Additional command line arguments to pass on to Pandoc.
 #' @param as_job Render as an RStudio background job. Default is "auto",
 #'   which will render individual documents normally and projects as
-#'   background jobs. Use the `quarto.render_as_job` R option to control
+#'   background jobs. Use the `quarto.render_as_job` \R option to control
 #'   the default globally.
 #'
 #' @importFrom rmarkdown relative_to

diff --git a/man/quarto_add_extension.Rd b/man/quarto_add_extension.Rd
diff --git a/man/quarto_create_project.Rd b/man/quarto_create_project.Rd
diff --git a/man/quarto_inspect.Rd b/man/quarto_inspect.Rd
diff --git a/man/quarto_render.Rd b/man/quarto_render.Rd
diff --git a/man/quarto_use_template.Rd b/man/quarto_use_template.Rd