Skip to content

Commit 5785273

Browse files
committed
amend #958: use a single paragraph because \item{} in Rd doesn't support more than one paragraph
1 parent f5f7e7c commit 5785273

File tree

3 files changed

+26
-28
lines changed

3 files changed

+26
-28
lines changed

NEWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## BUG FIXES
88

9-
- Correctly encode the document title when creating the twitter sharing link from a bookdown chapter (thanks, @maelle, #934).
9+
- Correctly encode the document title when creating the Twitter sharing link from a bookdown chapter (thanks, @maelle, #934).
1010

1111
- Make sure `search_index.json` contains valid characters for the JSON format (thanks, @wlandau, #913).
1212

@@ -18,7 +18,7 @@
1818

1919
## MINOR CHANGES
2020

21-
- Updated documentation for `render_book` to make it clearer how options are set for the `output_format` parameter (See #930) (thanks, @jonathan-g, #958)
21+
- Updated documentation for `render_book()` to make it clearer how options are set for the `output_format` parameter (thanks, @jonathan-g, #958 #930).
2222

2323
# CHANGES IN bookdown VERSION 0.20
2424

R/render.R

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@
1414
#' Markdown files specified by the book are rendered.
1515
#' @param output_format,...,clean,envir Arguments to be passed to
1616
#' \code{rmarkdown::\link{render}()}. For \code{preview_chapter()}, \code{...}
17-
#' is passed to \code{render_book()}.
18-
#'
19-
#' See \code{rmarkdown::\link{render}} and
20-
#' \href{https://bookdown.org/yihui/bookdown/build-the-book.html}{the bookdown
21-
#' reference book} for details on how output formatting options are set from
22-
#' YAML or parameters supplied by the user when calling \code{render_book()}.
17+
#' is passed to \code{render_book()}. See \code{rmarkdown::\link{render}()}
18+
#' and \href{https://bookdown.org/yihui/bookdown/build-the-book.html}{the
19+
#' bookdown reference book} for details on how output formatting options are
20+
#' set from YAML or parameters supplied by the user when calling
21+
#' \code{render_book()}.
2322
#' @param clean_envir This argument has been deprecated and will be removed in
2423
#' future versions of \pkg{bookdown}.
2524
#' @param output_dir The output directory. If \code{NULL}, a field named
@@ -40,12 +39,12 @@
4039
#' # see https://bookdown.org/yihui/bookdown for the full documentation
4140
#' if (file.exists('index.Rmd')) bookdown::render_book('index.Rmd')
4241
#' \dontrun{
43-
#' # will use the default format defined in _output.yml
44-
#' bookdown::render_book("index.Rmd")
45-
#' # will use the options for format defined in yaml
46-
#' bookdown::render_book("index.Rmd", "pdf_book")
47-
#' # If you pass an output format, it must have all the options set
48-
#' bookdown::render_book("index.Rmd", bookdown::pdf_book(toc = FALSE))
42+
#' # will use the default format defined in index.Rmd or _output.yml
43+
#' bookdown::render_book("index.Rmd")
44+
#' # will use the options for format defined in YAML metadata
45+
#' bookdown::render_book("index.Rmd", "pdf_book")
46+
#' # If you pass an output format object, it must have all the options set
47+
#' bookdown::render_book("index.Rmd", bookdown::pdf_book(toc = FALSE))
4948
#' }
5049
render_book = function(
5150
input, output_format = NULL, ..., clean = TRUE, envir = parent.frame(),

man/render_book.Rd

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

0 commit comments

Comments
 (0)