From 9cf52297e1591ef22c6c87e70856d4e650c25be5 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Thu, 14 Nov 2024 14:38:36 -0800 Subject: [PATCH] Remove invalid link to undocumented helper function --- R/utils.R | 12 ++++++------ man/time_delta_to_n_steps.Rd | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/R/utils.R b/R/utils.R index 348cf7fa..cb99ceca 100644 --- a/R/utils.R +++ b/R/utils.R @@ -1119,14 +1119,14 @@ validate_slide_window_arg <- function(arg, time_type, lower = 1, allow_inf = TRU #' in, if supported by the class of `time_delta`, even if `time_type` doesn't #' necessarily support Inf/-Inf entries. Basically a slide window arg but #' without sign and length restrictions. -#' @param time_type as in [`validate_slide_window_arg`] +#' @param time_type as in `validate_slide_window_arg` #' @return [bare integerish][rlang::is_integerish] vector (with possible #' infinite values) that produces the same result as `time_delta` when -#' multiplied by some "unit time step" for that time type and added to time -#' values of time type `time_type`. If the given time type does not support -#' infinite values, then it should produce +Inf or -Inf for analogous entries -#' of `time_delta`, and match the addition result match the addition result -#' for non-infinite entries. +#' multiplied by the "natural" "unit time delta" (not yet implemented) for +#' that time type and added to time values of time type `time_type`. If the +#' given time type does not support infinite values, then it should produce +#' +Inf or -Inf for analogous entries of `time_delta`, and match the addition +#' result match the addition result for non-infinite entries. #' #' @keywords internal time_delta_to_n_steps <- function(time_delta, time_type) { diff --git a/man/time_delta_to_n_steps.Rd b/man/time_delta_to_n_steps.Rd index 4c0bdcd6..db8cdaaa 100644 --- a/man/time_delta_to_n_steps.Rd +++ b/man/time_delta_to_n_steps.Rd @@ -14,16 +14,16 @@ in, if supported by the class of \code{time_delta}, even if \code{time_type} doe necessarily support Inf/-Inf entries. Basically a slide window arg but without sign and length restrictions.} -\item{time_type}{as in \code{\link{validate_slide_window_arg}}} +\item{time_type}{as in \code{validate_slide_window_arg}} } \value{ \link[rlang:is_integerish]{bare integerish} vector (with possible infinite values) that produces the same result as \code{time_delta} when -multiplied by some "unit time step" for that time type and added to time -values of time type \code{time_type}. If the given time type does not support -infinite values, then it should produce +Inf or -Inf for analogous entries -of \code{time_delta}, and match the addition result match the addition result -for non-infinite entries. +multiplied by the "natural" "unit time delta" (not yet implemented) for +that time type and added to time values of time type \code{time_type}. If the +given time type does not support infinite values, then it should produce ++Inf or -Inf for analogous entries of \code{time_delta}, and match the addition +result match the addition result for non-infinite entries. } \description{ Convert a time delta to a integerish number of "unit" steps between time values