diff --git a/man/clean.Rd b/man/clean.Rd index bf93399c..6a756a9b 100644 --- a/man/clean.Rd +++ b/man/clean.Rd @@ -7,10 +7,13 @@ clean(path = ".", echo = TRUE) } \arguments{ -\item{path}{[ string ] Path to the package root.} +\item{path}{character scalar, path to R package root.} \item{echo}{logical scalar, should cargo command and outputs be printed to -console (default is TRUE)} +console (default is \code{TRUE})} +} +\value{ +character vector with names of all deleted files (invisibly). } \description{ Removes Rust binaries (such as \code{.dll}/\code{.so} libraries), C wrapper object files, diff --git a/man/use_crate.Rd b/man/use_crate.Rd index a9489281..2341681f 100644 --- a/man/use_crate.Rd +++ b/man/use_crate.Rd @@ -33,7 +33,7 @@ crate} console (default is TRUE)} } \value{ -\code{NULL}, invisibly +\code{NULL} (invisibly) } \description{ Analogous to \code{usethis::use_package()} but for crate dependencies. diff --git a/man/write_license_note.Rd b/man/write_license_note.Rd index ff20923f..56872675 100644 --- a/man/write_license_note.Rd +++ b/man/write_license_note.Rd @@ -4,7 +4,7 @@ \alias{write_license_note} \title{Generate LICENSE.note file.} \usage{ -write_license_note(path = ".", echo = TRUE, quiet = FALSE, overwrite = TRUE) +write_license_note(path = ".", echo = TRUE, quiet = FALSE, force = TRUE) } \arguments{ \item{path}{character scalar, the R package directory} @@ -15,11 +15,11 @@ console (default is \code{TRUE})} \item{quiet}{logical scalar, whether to signal successful writing of LICENSE.note (default is \code{FALSE})} -\item{overwrite}{logical scalar, whether to regenerate LICENSE.note if +\item{force}{logical scalar, whether to regenerate LICENSE.note if LICENSE.note already exists (default is \code{TRUE})} } \value{ -No return value, called for side effects. +text printed to LICENSE.note (invisibly). } \description{ LICENSE.note generated by this function contains information about all