Skip to content

Commit 74c8bef

Browse files
committed
clarify the documentation of the xxx2 output formats: #944 (comment)
1 parent 5785273 commit 74c8bef

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

R/html.R

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ tufte_html_book = function(...) {
9797
#' These are simple wrappers of the output format functions like
9898
#' \code{rmarkdown::\link{html_document}()}, and they added the capability of
9999
#' numbering figures/tables/equations/theorems and cross-referencing them. See
100-
#' References for the syntax. Note you can also cross-reference sections by
101-
#' their ID's using the same syntax when sections are numbered. In case you want
102-
#' to enable cross reference in other formats, use \code{markdown_document2} with
103-
#' \code{base_format} argument.
100+
#' \sQuote{References} for the syntax. Note you can also cross-reference
101+
#' sections by their ID's using the same syntax when sections are numbered. In
102+
#' case you want to enable cross reference in other formats, use
103+
#' \code{markdown_document2} with \code{base_format} argument.
104104
#' @param ...,fig_caption,md_extensions,pandoc_args Arguments to be passed to a
105105
#' specific output format function. For a function \code{foo2()}, its
106106
#' arguments are passed to \code{foo()}, e.g. \code{...} of
@@ -114,10 +114,11 @@ tufte_html_book = function(...) {
114114
#' @inheritParams pdf_book
115115
#' @return An R Markdown output format object to be passed to
116116
#' \code{rmarkdown::\link{render}()}.
117-
#' @note These function are expected to work with a single R Markdown document
118-
#' instead of multiple documents of a book, so they are to be passed to
119-
#' \code{rmarkdown::render()} instead of \code{bookdown::render_book()}. The
120-
#' functions \samp{tufte_*()} are wrappers of funtions in the \pkg{tufte}
117+
#' @note These output formats are used to generate single output files, such as
118+
#' a single HTML output file (unlike \code{gitbook}, which generates multiple
119+
#' HTML output files by default).
120+
#'
121+
#' The functions \samp{tufte_*()} are wrappers of functions in the \pkg{tufte}
121122
#' package.
122123
#' @references \url{https://bookdown.org/yihui/bookdown/}
123124
#' @export

man/html_document2.Rd

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

0 commit comments

Comments
 (0)