Merge branch 'development' into rc

DESCRIPTION

@@ -2,7 +2,7 @@ Package: fansi
 Title: ANSI Control Sequence Aware String Functions
 Description: Counterparts to R string manipulation functions that account for
    the effects of ANSI text formatting control sequences.
-Version: 1.0.4
+Version: 1.0.4.9000
 Authors@R: c(
     person("Brodie", "Gaslam", email="brodie.gaslam@yahoo.com",
     role=c("aut", "cre")),
@@ -24,7 +24,7 @@ Suggests:
 Imports:
     grDevices,
     utils
-RoxygenNote: 7.1.1
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE, load = "installed")
 Encoding: UTF-8
 Collate:

R/fansi-package.R

@@ -270,6 +270,7 @@
 #'
 #' @useDynLib fansi, .registration=TRUE, .fixes="FANSI_"
 #' @docType package
+#' @aliases fansi-package
 #' @name fansi
 
 NULL

R/strsplit.R

@@ -35,6 +35,7 @@
 #' @inherit substr_ctl seealso
 #' @inheritSection substr_ctl Control and Special Sequences
 #' @inheritSection substr_ctl Output Stability
+#' @inheritSection substr_ctl Bidirectional Text
 #' @note Non-ASCII strings are converted to and returned in UTF-8 encoding.
 #'   Width calculations will not work properly in R < 3.2.2.
 #' @return Like [`base::strsplit`], with _Control Sequences_ excluded.

R/strwrap.R

@@ -36,6 +36,7 @@
 #' @inheritSection substr_ctl Control and Special Sequences
 #' @inheritSection substr_ctl Graphemes
 #' @inheritSection substr_ctl Output Stability
+#' @inheritSection substr_ctl Bidirectional Text
 #' @inheritParams base::strwrap
 #' @inheritParams tabs_as_spaces
 #' @inheritParams substr_ctl

R/substr2.R

@@ -148,17 +148,24 @@
 #' The [`utf8`](https://cran.r-project.org/package=utf8) package provides a
 #' conforming grapheme parsing implementation.
 #'
+#' @section Bidirectional Text:
+#'
+#' `fansi` is unaware of text directionality and operates as if all strings are
+#' left to right (LTR).  Using `fansi` function with strings that contain mixed
+#' direction scripts (i.e. both LTR and RTL) may produce undesirable results.
+#'
 #' @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].