From 707c9df58b28f54d9181ad525e0e8f7b819fc570 Mon Sep 17 00:00:00 2001 From: Lukas Pietzschmann Date: Fri, 30 Aug 2024 10:07:54 +0200 Subject: [PATCH] Fixed doc --- R/visit.R | 4 ++-- man/visit_node.Rd | 2 +- man/visit_nodes.Rd | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/visit.R b/R/visit.R index 5bbc619..7c1eb37 100644 --- 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. The callback should return TRUE to continue visiting the children of the node, or FALSE to stop visiting the children of the node. +#' @param callback The callback function to invoke for each node. The callback should return FALSE to stop visiting the children of the node, or anything else to continue. #' #' @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. The callback should return TRUE to continue visiting the children of the node, or FALSE to stop visiting the children of the node. +#' @param callback The callback function to invoke for each node. The callback should return FALSE to stop visiting the children of the node, or anything else to continue. #' #' @export visit_node <- function(node, callback) { diff --git a/man/visit_node.Rd b/man/visit_node.Rd index 298f7ce..eb15cc5 100644 --- a/man/visit_node.Rd +++ b/man/visit_node.Rd @@ -9,7 +9,7 @@ visit_node(node, callback) \arguments{ \item{node}{The node to visit} -\item{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.} +\item{callback}{The callback function to invoke for each node. The callback should return FALSE to stop visiting the children of the node, or anything else to continue.} } \description{ Visits the given node and all of their children, invoking the callback for each visited node diff --git a/man/visit_nodes.Rd b/man/visit_nodes.Rd index 7e6dfa6..edf553e 100644 --- a/man/visit_nodes.Rd +++ b/man/visit_nodes.Rd @@ -9,7 +9,7 @@ visit_nodes(nodes, callback) \arguments{ \item{nodes}{The list or array of nodes to visit} -\item{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.} +\item{callback}{The callback function to invoke for each node. The callback should return FALSE to stop visiting the children of the node, or anything else to continue.} } \description{ Visits the set of nodes and all of their children, invoking the callback for each visited node