(arrow) branch main updated: MINOR: [R] Document Message and MessageReader classes (#48651)

[jonkeane]

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 ac93e8de41 MINOR: [R] Document Message and MessageReader classes 
(#48651)
ac93e8de41 is described below

commit ac93e8de41945e213d256049e85495b6daaab3ea
Author: Hyukjin Kwon <gurwls...@apache.org>
AuthorDate: Sun Dec 28 01:00:19 2025 +0900

    MINOR: [R] Document Message and MessageReader classes (#48651)
    
    ### Rationale for this change
    
    There are TODOs for documentation which result in
    https://arrow.apache.org/docs/r/reference/Message.html and
    https://arrow.apache.org/docs/r/reference/MessageReader.html
    
    ### What changes are included in this PR?
    
    This PR documents `Message` and `MessageReader` 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/message.R | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/r/R/message.R b/r/R/message.R
index 897156738a..364e8b414e 100644
--- a/r/R/message.R
+++ b/r/R/message.R
@@ -19,13 +19,25 @@
 
 #' @title Message class
 #'
+#' @description
+#' `Message` holds an Arrow IPC message, which includes metadata and
+#' an optional message body.
+#'
 #' @usage NULL
 #' @format NULL
 #' @docType class
 #'
-#' @section Methods:
+#' @section R6 Methods:
+#'
+#' - `$Equals(other)`: Check if this `Message` is equal to another `Message`
+#' - `$body_length()`: Return the length of the message body in bytes
+#' - `$Verify()`: Check if the `Message` metadata is valid Flatbuffer format
 #'
-#' TODO
+#' @section Active bindings:
+#'
+#' - `$type`: The message type
+#' - `$metadata`: The message metadata
+#' - `$body`: The message body as a [Buffer]
 #'
 #' @rdname Message
 #' @name Message
@@ -48,13 +60,23 @@ Message <- R6Class(
 
 #' @title MessageReader class
 #'
+#' @description
+#' `MessageReader` reads `Message` objects from an input stream.
+#'
 #' @usage NULL
 #' @format NULL
 #' @docType class
 #'
-#' @section Methods:
+#' @section R6 Methods:
+#'
+#' - `$ReadNextMessage()`: Read the next `Message` from the stream. Returns 
`NULL` if
+#'   there are no more messages.
+#'
+#' @section Factory:
+#'
+#' `MessageReader$create()` takes the following argument:
 #'
-#' TODO
+#' - `stream`: An [InputStream] or object coercible to one (e.g., a raw vector)
 #'
 #' @rdname MessageReader
 #' @name MessageReader