wip

R/run.R

@@ -1,7 +1,7 @@
 #' Start hotwater engine
 #'
 #' @description
-#' Start a hotwater engine, which launches a plumber API
+#' Start the hotwater engine, launching a plumber API
 #' that is restarted whenever a file in the plumber API's folder is modified.
 #'
 #' Extra directories can be specified to refresh the API when
@@ -17,9 +17,17 @@
 #' to watch for file changes. Paths are resolved from the current working
 #' directory, not the directory of the plumber API file.
 #'
-#' @param port \[default `httpuv::randomPort()`] port to launch API on
+#' @param port \[default [httpuv::randomPort()]] port to launch API on.
 #'
-#' @param host \[default "127.0.0.1"] host to launch API on
+#' port can either be set explicitly, or it defaults to the
+#' `plumber.port` option. If the plumber option is undefined, the fallback
+#' value of [httpuv::randomPort()] is used.
+#'
+#' @param host \[default "127.0.0.1"] host to launch API on.
+#'
+#' host can either be set explicitly, or it defaults to the
+#' `plumber.host` option. If the plumber option is undefined, the fallback
+#' value of "127.0.0.1" is used.
 #'
 #' @param ignore \[default `c("*.sqlite", "*.git*")`] vector of file globs
 #' to ignore.