diff --git a/R/render.R b/R/render.R index d73967aa..006b5bf5 100644 --- a/R/render.R +++ b/R/render.R @@ -8,10 +8,9 @@ #' to rendering the project in the current working directory). #' @param output_format Target output format (defaults to `"html"`). The option #' `"all"` will render all formats defined within the file or project. -#' @param output_file The name of the output file. If using `NULL`, the output -#' filename will be based on the filename for the input file. `output_file` is -#' mapped to the `--output` option flag of the `quarto` CLI. It is expected to -#' be a filename only, not a path, relative or absolute. +#' @param output_file Base name for single-file output (e.g. PDF, ePub, MS Word). +#' This sets the `output-file` Quarto metadata. If `NULL`, the output filename +#' will be based on the input filename. #' @param execute Whether to execute embedded code chunks. #' @param execute_params A list of named parameters that override custom params #' specified within the YAML front-matter. diff --git a/man/quarto_render.Rd b/man/quarto_render.Rd index 243f3499..7b2e768b 100644 --- a/man/quarto_render.Rd +++ b/man/quarto_render.Rd @@ -34,10 +34,9 @@ to rendering the project in the current working directory).} \item{output_format}{Target output format (defaults to \code{"html"}). The option \code{"all"} will render all formats defined within the file or project.} -\item{output_file}{The name of the output file. If using \code{NULL}, the output -filename will be based on the filename for the input file. \code{output_file} is -mapped to the \code{--output} option flag of the \code{quarto} CLI. It is expected to -be a filename only, not a path, relative or absolute.} +\item{output_file}{Base name for single-file output (e.g. PDF, ePub, MS Word). +This sets the \code{output-file} Quarto metadata. If \code{NULL}, the output filename +will be based on the input filename.} \item{execute}{Whether to execute embedded code chunks.}