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

Open
HyukjinKwon wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −2
Open

MINOR: [R] Document FixedWidthType class #48652

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 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,13 +146,23 @@ 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
Expand Down
Loading