Skip to content

Commit

Permalink
fix: naming local books in examples
Browse files Browse the repository at this point in the history
  • Loading branch information
js2264 committed Oct 17, 2023
1 parent 6e12f20 commit 5142a71
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 10 deletions.
12 changes: 7 additions & 5 deletions R/doc.R
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,11 @@
#'
#' @examples
#' ## In practice, you should not use `.local` argument.
#' bb <- init('localbook', .local = TRUE)
#' bookname <- paste(Sys.info()[['sysname']], 'localbook1', sep = '.')
#' bb <- init(bookname, .local = TRUE)
#' add_preamble(bb, open = FALSE)
#' add_chapter(bb, title = "Chapitre Un", open = FALSE)
#' unlink('localbook', recursive = TRUE)
#' unlink(bookname, recursive = TRUE)
NULL

#' @title Handling BiocBook directories
Expand Down Expand Up @@ -167,9 +168,10 @@ NULL
#'
#' @examples
#' ## In practice, you should not use `.local` argument.
#' init('localbook', .local = TRUE)
#' bb <- BiocBook('localbook')
#' bookname <- paste(Sys.info()[['sysname']], 'localbook1', sep = '.')
#' init(bookname, .local = TRUE)
#' bb <- BiocBook(bookname)
#' chapters(bb)
#' releases(bb)
#' unlink('localbook', recursive = TRUE)
#' unlink(bookname, recursive = TRUE)
NULL
5 changes: 3 additions & 2 deletions man/BiocBook-editing.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/BiocBook.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5142a71

Please sign in to comment.