doc updates

Author: kevinushey

R/code.R

@@ -95,22 +95,22 @@ callFun <- function(fname, ...) {
     return(callRemote(sys.call(), parent.frame()))
 
   verifyAvailable()
-  if (usingTools())
-    found <- exists(toolsName(fname), envir = toolsEnv(), mode = "function")
-  else
-    found <- exists(fname, envir = asNamespace("rstudio"), mode = "function")
-  if (!found)
-    stop("Function ", fname, " not found in RStudio", call. = FALSE)
 
-  f <- findFun(fname, mode = "function")
+  # get reference to RStudio function
+  f <- tryCatch(findFun(fname, mode = "function"), error = identity)
+  if (inherits(f, "error"))
+    stop("Function ", fname, " not found in RStudio", call. = FALSE)
 
+  # drop arguments that aren't accepted by RStudio
+  # (ensure backwards-compatibility with older versions of RStudio)
   args <- list(...)
   if (!"..." %in% names(formals(f)))
-  {
-     while (length(args) > length(formals(f)))
-       args <- args[-length(args)]
-  }
+    if (length(args) > length(formals(f)))
+      length(args) <- length(formals(f))
+  
+  # invoke the function
   do.call(f, args)
+  
 }
 
 

R/remote.R

@@ -1,7 +1,16 @@
 
-#' Is this a job
+#' Detect RStudio Jobs
+#' 
+#' Use this function to detect whether RStudio is running an R "job".
+#' These jobs are normally used for actions taken in the Jobs tab, as well
+#' as within the \R build pane.
+#' 
+#' This function is primarily intended to be used by package authors, who
+#' need to customize the behavior of their methods when run within an
+#' RStudio job.
+#' 
+#' @return Boolean; `TRUE` if this is an RStudio job.
 #' 
-#' @return TRUE if this is a job
 #' @export
 isJob <- function() {
   !is.na(Sys.getenv("RSTUDIOAPI_IPC_REQUESTS_FILE", unset = NA))

R/stubs.R

@@ -336,8 +336,9 @@ savePlotAsImage <- function(file,
 #' 
 #' @param code The \R code to be executed, as a character vector.
 #' 
-#' @param execute Boolean; execute the code immediately or just enter the text
-#'   into the console?
+#' @param execute Boolean; should the code be executed after being submitted
+#'   to the console? If `FALSE`, `code` is submitted to the console but is
+#'   not executed.
 #'   
 #' @param echo Boolean; echo the code in the console as it is executed?
 #' 
@@ -351,7 +352,7 @@ savePlotAsImage <- function(file,
 #' @examples
 #' 
 #' \dontrun{
-#' rstudioapi::sendToConsole(".Platform", execute = TRUE)
+#' rstudioapi::sendToConsole(".Platform", execute = FALSE, animate = TRUE)
 #' }
 #' 
 #'