Skip to content

Commit

Permalink
Tweak documentation to clarify what reload does
Browse files Browse the repository at this point in the history
  • Loading branch information
jimhester committed Oct 16, 2018
1 parent 22ac85a commit 4face80
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
11 changes: 6 additions & 5 deletions R/reload.R
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
#' Unload and reload package.
#'
#' This attempts to unload and reload a package. If the package is not loaded
#' already, it does nothing. It's not always possible to cleanly unload a
#' package: see the caveats in [unload()] for some of the
#' potential failure points. If in doubt, restart R and reload the package
#' with [library()].
#' This attempts to unload and reload an _installed_ package. If the package is
#' not loaded already, it does nothing. It's not always possible to cleanly
#' unload a package: see the caveats in [unload()] for some of the potential
#' failure points. If in doubt, restart R and reload the package with
#' [library()].
#'
#' @param pkg package description, can be path or package name. See
#' [as.package()] for more information
#' @param quiet if `TRUE` suppresses output from this function.
#' @seealso [load_all()] to load a package for interactive development.
#' @examples
#' \dontrun{
#' # Reload package that is in current directory
Expand Down
13 changes: 8 additions & 5 deletions man/reload.Rd

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

0 comments on commit 4face80

Please sign in to comment.