From 50e3e4dc3a10855c559a4180496207ae2a211299 Mon Sep 17 00:00:00 2001
From: colin <colin@thinkr.fr>
Date: Fri, 26 May 2023 12:17:18 +0200
Subject: [PATCH] doc: roxygenized

---
 man/dockerfiles.Rd | 14 +++++++-------
 man/fill_desc.Rd   | 37 +++++++++++++++++++++++++------------
 man/pkg_tools.Rd   |  4 ++--
 3 files changed, 34 insertions(+), 21 deletions(-)

diff --git a/man/dockerfiles.Rd b/man/dockerfiles.Rd
index 04536333..6f9b0af7 100644
--- a/man/dockerfiles.Rd
+++ b/man/dockerfiles.Rd
@@ -57,7 +57,7 @@ add_dockerfile_heroku(
 )
 
 add_dockerfile_with_renv(
-  source_folder = ".",
+  source_folder = get_golem_wd(),
   lockfile = NULL,
   output_dir = fs::path(tempdir(), "deploy"),
   distro = "focal",
@@ -77,7 +77,7 @@ add_dockerfile_with_renv(
 )
 
 add_dockerfile_with_renv_shinyproxy(
-  source_folder = ".",
+  source_folder = get_golem_wd(),
   lockfile = NULL,
   output_dir = fs::path(tempdir(), "deploy"),
   distro = "focal",
@@ -94,7 +94,7 @@ add_dockerfile_with_renv_shinyproxy(
 )
 
 add_dockerfile_with_renv_heroku(
-  source_folder = ".",
+  source_folder = get_golem_wd(),
   lockfile = NULL,
   output_dir = fs::path(tempdir(), "deploy"),
   distro = "focal",
@@ -151,9 +151,9 @@ the Dockerfile directly mount the source folder.}
 \item{extra_sysreqs}{character vector. Extra debian system requirements.}
 
 \item{source_folder}{path to the Package/golem source folder to deploy.
-default is current folder '.'}
+default is retrieved via \code{\link[=get_golem_wd]{get_golem_wd()}}.}
 
-\item{lockfile}{path to the renv.lock file to use. default is \code{NULL}}
+\item{lockfile}{path to the renv.lock file to use. default is \code{NULL}.}
 
 \item{output_dir}{folder to export everything deployment related.}
 
@@ -163,9 +163,9 @@ See available distributions at https://hub.docker.com/r/rstudio/r-base/.}
 \item{document}{boolean. If TRUE (by default), DESCRIPTION file is updated using \code{\link[attachment:att_amend_desc]{attachment::att_amend_desc()}} before creating the renv.lock file}
 
 \item{dockerfile_cmd}{What is the CMD to add to the Dockerfile. If NULL, the default,
-the CMD will be \verb{R -e "options('shiny.port'=\{port\},shiny.host='\{host\}');library(\{appname\});\{appname\}::run_app()\\}}
+the CMD will be \verb{R -e "options('shiny.port'=\{port\},shiny.host='\{host\}');library(\{appname\});\{appname\}::run_app()\\}.}
 
-\item{...}{Other arguments to pass to \code{\link[renv:snapshot]{renv::snapshot()}}}
+\item{...}{Other arguments to pass to \code{\link[renv:snapshot]{renv::snapshot()}}.}
 }
 \value{
 The \code{{dockerfiler}} object, invisibly.
diff --git a/man/fill_desc.Rd b/man/fill_desc.Rd
index a851ae08..571a6c48 100644
--- a/man/fill_desc.Rd
+++ b/man/fill_desc.Rd
@@ -8,13 +8,16 @@ fill_desc(
   pkg_name,
   pkg_title,
   pkg_description,
-  author_first_name,
-  author_last_name,
-  author_email,
-  author_orcid = NULL,
+  authors = person(given = NULL, family = NULL, email = NULL, role = NULL, comment =
+    NULL),
   repo_url = NULL,
   pkg_version = "0.0.0.9000",
-  pkg = get_golem_wd()
+  pkg = get_golem_wd(),
+  author_first_name = NULL,
+  author_last_name = NULL,
+  author_email = NULL,
+  author_orcid = NULL,
+  set_options = TRUE
 )
 }
 \arguments{
@@ -24,19 +27,29 @@ fill_desc(
 
 \item{pkg_description}{Description of the package}
 
-\item{author_first_name}{First Name of the author}
-
-\item{author_last_name}{Last Name of the author}
-
-\item{author_email}{Email of the author}
-
-\item{author_orcid}{ORCID of the author}
+\item{authors}{a character string (or vector) of class person
+(see \code{\link[=person]{person()}} for details)}
 
 \item{repo_url}{URL (if needed)}
 
 \item{pkg_version}{The version of the package. Default is 0.0.0.9000}
 
 \item{pkg}{Path to look for the DESCRIPTION. Default is \code{get_golem_wd()}.}
+
+\item{author_first_name}{to be deprecated: use character for first name via
+\code{authors = person(given = "authors_first_name")} instead}
+
+\item{author_last_name}{to be deprecated: use character for last name via
+\code{authors = person(given = "authors_last_name")} instead}
+
+\item{author_email}{to be deprecated: use character for first name via
+\code{authors = person(email = "author_email")} instead}
+
+\item{author_orcid}{to be deprecated}
+
+\item{set_options}{logical; if \code{TRUE} then \code{\link[=set_golem_options]{set_golem_options()}} is run,
+which is the default; if \code{FALSE} then running \code{\link[=set_golem_options]{set_golem_options()}}
+manually at some point is strongly recommended}
 }
 \value{
 The {desc} object, invisibly.
diff --git a/man/pkg_tools.Rd b/man/pkg_tools.Rd
index d9a5869a..48b7c895 100644
--- a/man/pkg_tools.Rd
+++ b/man/pkg_tools.Rd
@@ -6,9 +6,9 @@
 \alias{pkg_path}
 \title{Package tools}
 \usage{
-pkg_name(path = ".")
+pkg_name(path = get_golem_wd())
 
-pkg_version(path = ".")
+pkg_version(path = get_golem_wd())
 
 pkg_path()
 }