Skip to content

Commit

Permalink
add namespace to randomNames in .sample_names documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlambert committed Jan 10, 2025
1 parent f9c042d commit 2f7875c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#' exhausting number of name when `sample.with.replacement = FALSE`. The
#' duplicated names during sampling need to be removed to ensure each
#' individual has a unique name. In order to have enough unique names, more
#' names than required are sampled from [randomNames()], and the level of
#' oversampling is determined by the `buffer_factor` argument. A
#' names than required are sampled from [randomNames::randomNames()], and the
#' level of oversampling is determined by the `buffer_factor` argument. A
#' `buffer_factor` too high and the more names are sampled which takes longer,
#' a `buffer_factor` too low and not enough unique names are sampled and
#' the `.sample_names()` function will need to loop until it has enough
Expand All @@ -15,7 +15,7 @@
#' @inheritParams .add_cols
#' @param buffer_factor A single `numeric` determining the level of
#' oversampling (or buffer) when creating a vector of unique names from
#' [randomNames()].
#' [randomNames::randomNames()].
#'
#' @return A `character` vector.
#' @keywords internal
Expand Down
6 changes: 3 additions & 3 deletions man/dot-sample_names.Rd

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

0 comments on commit 2f7875c

Please sign in to comment.