Skip to content

Conversation

@HyukjinKwon
Copy link
Member

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.

@HyukjinKwon HyukjinKwon changed the title MINOR: [R] Document FixedWidthType MINOR: [R] Document FixedWidthType class Dec 26, 2025
@github-actions github-actions bot added the awaiting review Awaiting review label Dec 26, 2025
Copy link
Member

@jonkeane jonkeane left a comment

Choose a reason for hiding this comment

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

Thanks for these small improvements 🙏

Comment on lines +149 to +153
#' @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.
Copy link
Member

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?

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Dec 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants