More accurate documentation for queue

AnthonyEbert · Sep 4, 2018 · f57d576 · f57d576
1 parent f90cbdb
commit f57d576
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/R/core_queuefunctions.R b/R/core_queuefunctions.R
@@ -6,7 +6,8 @@
 #' @param servers a non-zero natural number, an object of class \code{server.stepfun}
 #' or an object of class \code{server.list}.
 #' @param serveroutput boolean whether the server used by each customer should be returned.
-#' @description \code{queue} is a faster internal version of \code{queue_step}. It is not compatible with the \code{summary.queue_list} method or the \code{plot.queue_list} method.
+#' @description \code{queue} is a faster version of \code{queue_step} but the input returned is much simpler. It is not compatible with the \code{summary.queue_list} method or the \code{plot.queue_list} method.
+#' @details If the arrival vector is out of order the function will reorder it. The same reordering will be applied to the service vector, this is so each customer keeps their service time. Once the queue is computed the original order is put back.
 #' @examples
 #' n <- 1e2
 #' arrivals <- cumsum(rexp(n, 1.8))

diff --git a/man/queue.Rd b/man/queue.Rd