Skip to content

Commit

Permalink
Update argument names in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jdblischak committed Mar 22, 2024
1 parent ada0b24 commit ba959a3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions R/sim_gs_n.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#' arguments will change as we add additional features.
#'
#' @inheritParams sim_fixed_n
#' @param tests One or more test functions such as [wlr()], [maxcombo()], or
#' @param test One or more test functions such as [wlr()], [maxcombo()], or
#' [rmst()]. If a single test function is provided, it will be applied at each
#' cut. Alternatively a list of functions created by [create_test()]. The list
#' form is experimental and currently limited. It only accepts one test per
Expand All @@ -31,8 +31,8 @@
#' flexible in the future). Importantly, note that the simulated data set is
#' always passed as the first positional argument to each test function
#' provided.
#' @param cuts A list of cutting functions created by [create_cut()],
#' see examples.
#' @param cut A list of cutting functions created by [create_cut()], see
#' examples.
#' @param seed Random seed.
#' @param ... Arguments passed to the test function(s) provided by the argument
#' `tests`.
Expand Down
16 changes: 8 additions & 8 deletions man/sim_gs_n.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ba959a3

Please sign in to comment.