This is an automated email from the ASF dual-hosted git repository.
jonkeane 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 625465ba82 MINOR: [R] Document FixedWidthType class (#48652)
625465ba82 is described below
commit 625465ba821f0673d5c31672b02b8b4d14f969fb
Author: Hyukjin Kwon <[email protected]>
AuthorDate: Tue Dec 30 02:14:16 2025 +0900
MINOR: [R] Document FixedWidthType class (#48652)
### Rationale for this change
There are a TODO for documentation which result in
https://arrow.apache.org/docs/r/reference/FixedWidthType.html
### What changes are included in this PR?
This PR documents `FixedWidthType` classes.
### Are these changes tested?
I did not test them as they are documentation changes.
### Are there any user-facing changes?
Yes, it fixes the user facing documentation.
---
r/R/type.R | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/r/R/type.R b/r/R/type.R
index 8cd2d324a7..27cb0afe3d 100644
--- a/r/R/type.R
+++ b/r/R/type.R
@@ -146,16 +146,27 @@ infer_type.Expression <- function(x, ...) x$type()
#' @title FixedWidthType class
#'
+#' @description
+#' `FixedWidthType` is a base class for data types with a fixed width in bits.
+#' This includes all integer types, floating-point types, `Boolean`,
+#' `FixedSizeBinary`, temporal types (dates, times, timestamps, durations),
+#' and decimal types.
+#'
#' @usage NULL
#' @format NULL
#' @docType class
#'
-#' @section Methods:
+#' @section R6 Methods:
+#'
+#' `FixedWidthType` inherits from [DataType], so it has the same methods.
+#'
+#' @section Active bindings:
#'
-#' TODO
+#' - `$bit_width`: The width of the type in bits
#'
#' @rdname FixedWidthType
#' @name FixedWidthType
+#' @keywords internal
FixedWidthType <- R6Class(
"FixedWidthType",
inherit = DataType,
