Skip to content

Commit 687ccbc

Browse files
salim-bcderv
andauthored
docs: update output_file param desc (#280)
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
1 parent f72f10b commit 687ccbc

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

R/render.R

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
#' to rendering the project in the current working directory).
99
#' @param output_format Target output format (defaults to `"html"`). The option
1010
#' `"all"` will render all formats defined within the file or project.
11-
#' @param output_file The name of the output file. If using `NULL`, the output
12-
#' filename will be based on the filename for the input file. `output_file` is
13-
#' mapped to the `--output` option flag of the `quarto` CLI. It is expected to
14-
#' be a filename only, not a path, relative or absolute.
11+
#' @param output_file Base name for single-file output (e.g. PDF, ePub, MS Word).
12+
#' This sets the `output-file` Quarto metadata. If `NULL`, the output filename
13+
#' will be based on the input filename.
1514
#' @param execute Whether to execute embedded code chunks.
1615
#' @param execute_params A list of named parameters that override custom params
1716
#' specified within the YAML front-matter.

man/quarto_render.Rd

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

0 commit comments

Comments
 (0)