Skip to content

MINOR: [R] Document FixedWidthType class #48652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonkeane merged 2 commits into from
Dec 29, 2025
+13 −2
Merged

MINOR: [R] Document FixedWidthType class #48652

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4988d08
[R] Document FixedWidthType
HyukjinKwon Dec 26, 2025
2d1d36d
Address a review comment
HyukjinKwon Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions r/R/type.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment on lines +149 to +153
Copy link
Member

@jonkeane jonkeane Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mark this as internal with #' @keywords internal or at the least add a note in here that this is basically an internal type, not something that users of Arrow should need?

#'
#' @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,
Expand Down
Loading