Skip to content

Commit

Permalink
work-around for roxygen2 breaking change wrt inheritParams
Browse files Browse the repository at this point in the history
We can no longer inherit a subset of joint documented parameters.
  • Loading branch information
brodieG committed Oct 7, 2023
1 parent 6b10428 commit 58d76d5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion R/substr2.R
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,15 @@
#' @note Non-ASCII strings are converted to and returned in UTF-8 encoding.
#' Width calculations will not work properly in R < 3.2.2.
#' @note If `stop` < `start`, the return value is always an empty string.
#' @inheritParams base::substr
#' @export
#' @seealso [`?fansi`][fansi] for details on how _Control Sequences_ are
#' interpreted, particularly if you are getting unexpected results,
#' [`normalize_state`] for more details on what the `normalize` parameter does,
#' [`state_at_end`] to compute active state at the end of strings,
#' [`close_state`] to compute the sequence required to close active state.
#' @param x a character vector or object that can be coerced to such.
#' @param start integer. The first element to be extracted or replaced.
#' @param stop integer. The first element to be extracted or replaced.
#' @param type character(1L) partial matching
#' `c("chars", "width", "graphemes")`, although types other than "chars" only
#' work correctly with R >= 3.2.2. See [`?nchar`][base::nchar].
Expand Down

0 comments on commit 58d76d5

Please sign in to comment.