From de4eced916c3502c73b0db2c06d0ba06706f6c8e Mon Sep 17 00:00:00 2001 From: Thomas Mailund Date: Fri, 9 Feb 2018 12:23:53 +0100 Subject: [PATCH] Documentation --- R/loop-transformation.R | 5 +++++ man/can_loop_transform.Rd | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/R/loop-transformation.R b/R/loop-transformation.R index ab4491b..ff7c02d 100644 --- a/R/loop-transformation.R +++ b/R/loop-transformation.R @@ -116,6 +116,11 @@ check_function_argument <- function(fun) { #' @describeIn can_loop_transform This version expects \code{fun_body} to be qboth tested #' and user-transformed. +#' +#' @param fun_name Name of the recursive function. +#' @param fun_body The user-transformed function body. +#' @param env Environment used to look up variables used in \code{fun_body}. +#' #' @export can_loop_transform_body <- function(fun_name, fun_body, env) { fun_body <- user_transform(fun_body, env) diff --git a/man/can_loop_transform.Rd b/man/can_loop_transform.Rd index c7ed51f..6e50ef0 100644 --- a/man/can_loop_transform.Rd +++ b/man/can_loop_transform.Rd @@ -13,6 +13,12 @@ can_loop_transform_(fun) can_loop_transform(fun) } \arguments{ +\item{fun_name}{Name of the recursive function.} + +\item{fun_body}{The user-transformed function body.} + +\item{env}{Environment used to look up variables used in \code{fun_body}.} + \item{fun}{The function to check. Must be provided by its (bare symbol) name.} } \description{