inherit linelist argument from messy_linelist

epiverse-trace · Feb 19, 2025 · a95941d · a95941d
1 parent 62a6a5c
commit a95941d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/R/checkers.R b/R/checkers.R
@@ -366,7 +366,7 @@
 #' the class of the object, in other words, it does not check the object is
 #' of class `<linelist>`.
 #'
-#' @inheritParams truncate_linelist
+#' @inheritParams messy_linelist
 #'
 #' @return Invisibly return the `linelist` `<data.frame>`. The function is
 #' called for its side-effects, which will error if the input is invalid.

diff --git a/R/truncate_linelist.R b/R/truncate_linelist.R
@@ -17,7 +17,7 @@
 #' to the variability in the reporting delays. See examples for variable or
 #' fixed `delay` functions.
 #'
-#' @param linelist A `<data.frame>` output from [sim_linelist()].
+#' @inheritParams messy_linelist
 #' @param delay A `function` (either anonymous or predefined) that
 #' has a single argument and generates random numbers given a probability
 #' distribution. The function must return a vector of real numbers for

diff --git a/man/dot-check_linelist.Rd b/man/dot-check_linelist.Rd
diff --git a/man/truncate_linelist.Rd b/man/truncate_linelist.Rd