From 520506c3dbe8c4a9d5948898c9857e11caf3615c Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 7 Mar 2024 14:26:12 +0100 Subject: [PATCH] Improve documentation (#162) --- R/render.R | 11 ++++++----- man/quarto_add_extension.Rd | 7 ++++--- man/quarto_create_project.Rd | 7 ++++--- man/quarto_inspect.Rd | 7 ++++--- man/quarto_render.Rd | 11 ++++++----- man/quarto_use_template.Rd | 7 ++++--- 6 files changed, 28 insertions(+), 22 deletions(-) diff --git a/R/render.R b/R/render.R index 6cc440e..40f70fe 100644 --- 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 index 8232005..85c72c9 100644 --- a/man/quarto_add_extension.Rd +++ b/man/quarto_add_extension.Rd @@ -20,9 +20,10 @@ repository as described in the documentation \item{quiet}{Suppress warning and other messages.} -\item{quarto_args}{Character vector of other \code{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.} +\item{quarto_args}{Character vector of other \code{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.} } \description{ Add an extension to this folder or project by running \verb{quarto add} diff --git a/man/quarto_create_project.Rd b/man/quarto_create_project.Rd index c72cb3c..c91a1ec 100644 --- a/man/quarto_create_project.Rd +++ b/man/quarto_create_project.Rd @@ -25,9 +25,10 @@ quarto_create_project( \item{quiet}{Suppress warning and other messages.} -\item{quarto_args}{Character vector of other \code{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.} +\item{quarto_args}{Character vector of other \code{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.} } \description{ This function calls \verb{quarto create project }. It will create a diff --git a/man/quarto_inspect.Rd b/man/quarto_inspect.Rd index 36696c6..b27ac7a 100644 --- a/man/quarto_inspect.Rd +++ b/man/quarto_inspect.Rd @@ -14,9 +14,10 @@ a character vector of profile names or \code{NULL} to use the default profile.} \item{quiet}{Suppress warning and other messages.} -\item{quarto_args}{Character vector of other \code{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.} +\item{quarto_args}{Character vector of other \code{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.} } \value{ Named list. For input files, the list contains the elements diff --git a/man/quarto_render.Rd b/man/quarto_render.Rd index f16d112..87bb417 100644 --- a/man/quarto_render.Rd +++ b/man/quarto_render.Rd @@ -81,15 +81,16 @@ specified, with low precedence on \code{metadata} options.} \item{profile}{\href{https://quarto.org/docs/projects/profiles.html}{Quarto project profile(s)} to use. Either a character vector of profile names or \code{NULL} to use the default profile.} -\item{quarto_args}{Character vector of other \code{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.} +\item{quarto_args}{Character vector of other \code{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.} -\item{pandoc_args}{Additional command line options to pass to pandoc.} +\item{pandoc_args}{Additional command line arguments to pass on to Pandoc.} \item{as_job}{Render as an RStudio background job. Default is "auto", which will render individual documents normally and projects as -background jobs. Use the \code{quarto.render_as_job} R option to control +background jobs. Use the \code{quarto.render_as_job} \R option to control the default globally.} } \description{ diff --git a/man/quarto_use_template.Rd b/man/quarto_use_template.Rd index 9d0c6d6..6b88e4c 100644 --- a/man/quarto_use_template.Rd +++ b/man/quarto_use_template.Rd @@ -20,9 +20,10 @@ repository as described in the documentation \item{quiet}{Suppress warnings and messages.} -\item{quarto_args}{Character vector of other \code{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.} +\item{quarto_args}{Character vector of other \code{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.} } \description{ Install and use a template for Quarto using \verb{quarto use}.