From d71b135768cda83a3438e22362115ed7c2bbabd6 Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Fri, 26 Apr 2024 12:28:41 -0400 Subject: [PATCH] Add `quarto render --help` information to function help page closes #173 --- R/render.R | 2 +- man/quarto_add_extension.Rd | 2 +- man/quarto_create_project.Rd | 2 +- man/quarto_inspect.Rd | 2 +- man/quarto_render.Rd | 2 +- man/quarto_use_template.Rd | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/render.R b/R/render.R index 6069d1b..c8fee33 100644 --- a/R/render.R +++ b/R/render.R @@ -44,7 +44,7 @@ #' @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. +#' dedicated parameter of this \R function. See `quarto render --help` for options. #' @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 diff --git a/man/quarto_add_extension.Rd b/man/quarto_add_extension.Rd index 85c72c9..a85421b 100644 --- a/man/quarto_add_extension.Rd +++ b/man/quarto_add_extension.Rd @@ -23,7 +23,7 @@ repository as described in the documentation \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.} +dedicated parameter of this \R function. See \verb{quarto render --help} for options.} } \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 c91a1ec..806ec9f 100644 --- a/man/quarto_create_project.Rd +++ b/man/quarto_create_project.Rd @@ -28,7 +28,7 @@ quarto_create_project( \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.} +dedicated parameter of this \R function. See \verb{quarto render --help} for options.} } \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 b27ac7a..d8a6b9d 100644 --- a/man/quarto_inspect.Rd +++ b/man/quarto_inspect.Rd @@ -17,7 +17,7 @@ a character vector of profile names or \code{NULL} to use the default profile.} \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.} +dedicated parameter of this \R function. See \verb{quarto render --help} for options.} } \value{ Named list. For input files, the list contains the elements diff --git a/man/quarto_render.Rd b/man/quarto_render.Rd index 8413236..e39d3bf 100644 --- a/man/quarto_render.Rd +++ b/man/quarto_render.Rd @@ -84,7 +84,7 @@ a character vector of profile names or \code{NULL} to use the default profile.} \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.} +dedicated parameter of this \R function. See \verb{quarto render --help} for options.} \item{pandoc_args}{Additional command line arguments to pass on to Pandoc.} diff --git a/man/quarto_use_template.Rd b/man/quarto_use_template.Rd index 6b88e4c..9e15c88 100644 --- a/man/quarto_use_template.Rd +++ b/man/quarto_use_template.Rd @@ -23,7 +23,7 @@ repository as described in the documentation \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.} +dedicated parameter of this \R function. See \verb{quarto render --help} for options.} } \description{ Install and use a template for Quarto using \verb{quarto use}.