Updated doc

flowr-analysis · Aug 30, 2024 · 8604251 · 8604251
1 parent 0e46211
commit 8604251
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/R/visit.R b/R/visit.R
@@ -1,7 +1,7 @@
 #' Visits the set of nodes and all of their children, invoking the callback for each visited node
 #'
 #' @param nodes The list or array of nodes to visit
-#' @param callback The callback function to invoke for each node
+#' @param callback The callback function to invoke for each node. The callback should return TRUE to continue visiting the children of the node, or FALSE to stop visiting the children of the node.
 #'
 #' @export
 visit_nodes <- function(nodes, callback) {
@@ -15,7 +15,7 @@ visit_nodes <- function(nodes, callback) {
 #' Visits the given node and all of their children, invoking the callback for each visited node
 #'
 #' @param node The node to visit
-#' @param callback The callback function to invoke for each node
+#' @param callback The callback function to invoke for each node. The callback should return TRUE to continue visiting the children of the node, or FALSE to stop visiting the children of the node.
 #'
 #' @export
 visit_node <- function(node, callback) {

diff --git a/man/visit_node.Rd b/man/visit_node.Rd
diff --git a/man/visit_nodes.Rd b/man/visit_nodes.Rd