From aa16441f39577a8bf21e1d409c4f40ff0297cdc8 Mon Sep 17 00:00:00 2001
From: js2264 <jacquesserizay@gmail.com>
Date: Thu, 5 Oct 2023 10:00:05 +0200
Subject: [PATCH] doc: improve @return for `?BiocBook`

---
 R/doc.R         | 10 +++++++++-
 man/BiocBook.Rd |  8 +++++++-
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/R/doc.R b/R/doc.R
index e0a5372..2ccd3b9 100644
--- a/R/doc.R
+++ b/R/doc.R
@@ -145,7 +145,12 @@ NULL
 #' 
 #' `status(biocbook)`
 #' 
-#' @return A `BiocBook` object (invisible). 
+#' @return
+#' - `init("newBook")` creates a local directory, synchronizes it with the 
+#' registered GitHub user, and invisibly returns a `BiocBook` object. 
+#' - `BiocBook("newBook")` returns a `BiocBook` object.
+#' - `path(bb)`, `releases(bb)` and `chapters(bb)` return the corresponding 
+#' information related to the `bb` BiocBook.
 #' 
 #' @param new_package Name to use when initiating a new `BiocBook`. 
 #' This name should be compatible with package naming conventions 
@@ -154,6 +159,9 @@ NULL
 #' remote Github origin. If NA, a prompt will ask whether to push commits or 
 #' not (default: NA). 
 #' @param skip_availability Optional. Whether to skip package name availability
+#' (default: FALSE).
+#' @param .local Should only be used for examples/tests. Whether to create a 
+#' matching Github repository or stay local (default: FALSE).
 #' @param path Path of an existing `BiocBook`. 
 #' @param object A `BiocBook` object, created by `BiocBook` or `init()`.
 #' 
diff --git a/man/BiocBook.Rd b/man/BiocBook.Rd
index d5fa691..0bdae3f 100644
--- a/man/BiocBook.Rd
+++ b/man/BiocBook.Rd
@@ -49,7 +49,13 @@ matching Github repository or stay local (default: FALSE).}
 \item{object}{A \code{BiocBook} object, created by \code{BiocBook} or \code{init()}.}
 }
 \value{
-A \code{BiocBook} object (invisible).
+\itemize{
+\item \code{init("newBook")} creates a local directory, synchronizes it with the
+registered GitHub user, and invisibly returns a \code{BiocBook} object.
+\item \code{BiocBook("newBook")} returns a \code{BiocBook} object.
+\item \code{path(bb)}, \code{releases(bb)} and \code{chapters(bb)} return the corresponding
+information related to the \code{bb} BiocBook.
+}
 }
 \description{
 \code{BiocBook}s are local R packages containing an extra \code{pages} folder to