doc: improve all_simple_paths() documentation

R/paths.R

@@ -68,15 +68,14 @@ is.dag <- function(graph) { # nocov start
 
 #' List all simple paths from one source
 #'
-#' This function lists are simple paths from one source vertex to another
-#' vertex or vertices. A path is simple if the vertices it visits are not
-#' visited more than once.
+#' This function lists all simple paths from one source vertex to another
+#' vertex or vertices. A path is simple if contains no repeated vertices.
 #'
 #' Note that potentially there are exponentially many paths between two
 #' vertices of a graph, and you may run out of memory when using this
 #' function, if your graph is lattice-like.
 #'
-#' This function currently ignored multiple and loop edges.
+#' This function ignores multiple and loop edges.
 #'
 #' @param graph The input graph.
 #' @param from The source vertex.
@@ -87,7 +86,8 @@ is.dag <- function(graph) { # nocov start
 #'   then *to* it will be considered. If `all`, the default, then
 #'   the corresponding undirected graph will be used, i.e. not directed paths
 #'   are searched. This argument is ignored for undirected graphs.
-#' @param cutoff Maximum length of path that is considered. If negative, paths of all lengths are considered.
+#' @param cutoff Maximum length of the paths that are considered. If negative,
+#'   no cutoff is used.
 #' @return A list of integer vectors, each integer vector is a path from
 #'   the source vertex to one of the target vertices. A path is given by its
 #'   vertex ids.