You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by th...@apache.org on 2023/06/23 13:10:34 UTC

[arrow] branch main updated: MINOR: [R] Update phrasing of match_arrow docs to match base R (#36262)

This is an automated email from the ASF dual-hosted git repository.

thisisnic pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/main by this push:
     new 6ab18a7671 MINOR: [R] Update phrasing of match_arrow docs to match base R  (#36262)
6ab18a7671 is described below

commit 6ab18a767188cbd7c81468e98c8237d24c989b37
Author: Nic Crane <th...@gmail.com>
AuthorDate: Fri Jun 23 14:10:27 2023 +0100

    MINOR: [R] Update phrasing of match_arrow docs to match base R  (#36262)
    
    Make the phrasing more clear when skimming the reference page on pkgdown
    
    Authored-by: Nic Crane <th...@gmail.com>
    Signed-off-by: Nic Crane <th...@gmail.com>
---
 r/R/compute.R        | 6 +++---
 r/man/match_arrow.Rd | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/r/R/compute.R b/r/R/compute.R
index 1cd12f2e29..9848de0372 100644
--- a/r/R/compute.R
+++ b/r/R/compute.R
@@ -216,10 +216,10 @@ all.ArrowDatum <- function(..., na.rm = FALSE) {
   scalar_aggregate("all", ..., na.rm = na.rm)
 }
 
-#' `match` and `%in%` for Arrow objects
+#' Value matching for Arrow objects
 #'
-#' `base::match()` is not a generic, so we can't just define Arrow methods for
-#' it. This function exposes the analogous functions in the Arrow C++ library.
+#' `base::match()` and `base::%in%` are not generics, so we can't just define Arrow methods for
+#' them. These functions expose the analogous functions in the Arrow C++ library.
 #'
 #' @param x `Scalar`, `Array` or `ChunkedArray`
 #' @param table `Scalar`, Array`, `ChunkedArray`, or R vector lookup table.
diff --git a/r/man/match_arrow.Rd b/r/man/match_arrow.Rd
index 0406c95416..3457b4efe6 100644
--- a/r/man/match_arrow.Rd
+++ b/r/man/match_arrow.Rd
@@ -3,7 +3,7 @@
 \name{match_arrow}
 \alias{match_arrow}
 \alias{is_in}
-\title{\code{match} and \code{\%in\%} for Arrow objects}
+\title{Value matching for Arrow objects}
 \usage{
 match_arrow(x, table, ...)
 
@@ -23,8 +23,8 @@ and type as \code{x} with the (0-based) indexes into \code{table}. \code{is_in()
 per element of \code{x} it it is present in \code{table}.
 }
 \description{
-\code{base::match()} is not a generic, so we can't just define Arrow methods for
-it. This function exposes the analogous functions in the Arrow C++ library.
+\code{base::match()} and \verb{base::\%in\%} are not generics, so we can't just define Arrow methods for
+them. These functions expose the analogous functions in the Arrow C++ library.
 }
 \examples{
 # note that the returned value is 0-indexed