This is an automated email from the ASF dual-hosted git repository.
kou 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 5a529166e3 GH-46717: [R][Docs] Add missing "internal" keywords for
internal function (#46722)
5a529166e3 is described below
commit 5a529166e399c4b35fb2768278e8326bbcb5a9a8
Author: Nic Crane <[email protected]>
AuthorDate: Fri Jun 6 01:06:28 2025 +0100
GH-46717: [R][Docs] Add missing "internal" keywords for internal function
(#46722)
### Rationale for this change
pkgdown generation was failing due to a function not being included in the
list of functions to document
### What changes are included in this PR?
Update roxygen header to not generate that function or trigger the pkgdown
check
### Are these changes tested?
Nah, but I'll trigger CI to check
### Are there any user-facing changes?
No
* GitHub Issue: #46717
Authored-by: Nic Crane <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
r/R/dplyr-funcs-agg.R | 1 +
r/man/one.Rd | 9 +++++----
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/r/R/dplyr-funcs-agg.R b/r/R/dplyr-funcs-agg.R
index b67af6fc01..d1f2a2c3f5 100644
--- a/r/R/dplyr-funcs-agg.R
+++ b/r/R/dplyr-funcs-agg.R
@@ -204,6 +204,7 @@ find_arrow_mask <- function() {
#' group_by(cyl) |>
#' summarize(x = one(disp))
#' }
+#' @keywords internal
one <- function(...) {
set_agg(
fun = "one",
diff --git a/r/man/one.Rd b/r/man/one.Rd
index 5b672b5c19..654d789595 100644
--- a/r/man/one.Rd
+++ b/r/man/one.Rd
@@ -10,10 +10,10 @@ one(...)
\item{...}{Unquoted column name to pull values from.}
}
\description{
-Returns one arbitrary value from the input for each group. The
-function is biased towards non-null values: if there is at least one non-null
-value for a certain group, that value is returned, and only if all the values
-are null for the group will the function return null.
+Returns one arbitrary value from the input for each group. The function is
+biased towards non-null values: if there is at least one non-null value for a
+certain group, that value is returned, and only if all the values are null
+for the group will the function return null.
}
\examples{
\dontrun{
@@ -23,3 +23,4 @@ mtcars |>
summarize(x = one(disp))
}
}
+\keyword{internal}