Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions .github/workflows/r_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

name: R documentation

on:
push:
paths:
- '.github/workflows/r_docs.yml'
- 'r/R/*.R'
branches-ignore:
- master

jobs:
roxygen:
name: Build and Push
runs-on: ubuntu-latest
if: github.repository != 'apache/arrow'
steps:
- uses: actions/checkout@v2
- uses: r-lib/actions/setup-r@v1
- name: Install dependencies
run: Rscript -e 'source("ci/etc/rprofile"); install.packages(c("remotes", "roxygen2")); remotes::install_deps("r")'
- name: Render docs
run: Rscript -e 'roxygen2::roxygenize("r")'
- name: Commit results
run: |
git config user.name "$(git log -1 --pretty=format:%an)"
git config user.email "$(git log -1 --pretty=format:%ae)"
git commit -a -m 'Update docs [automated commit]' || echo "No changes to commit"
git push origin ${{ github.ref }} || echo "No changes to commit"
12 changes: 9 additions & 3 deletions r/R/message.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,21 @@

#' @include arrow-package.R

#' @title class arrow::Message
#' @title Message
#'
#' @usage NULL
#' @format NULL
#' @docType class
#'
#' @section Methods:
#'
#' TODO
#' * `$Equals(other)`: Test for equality
#' * `$body_length()`:
#' * `$Verify()`:
#' @section Active bindings:
#' * `$type`:
#' * `$metadata`:
#' * `$body`:
#'
#' @rdname Message
#' @name Message
Expand Down Expand Up @@ -74,7 +80,7 @@ MessageReader$create <- function(stream) {
#' Read a Message from a stream
#'
#' @param stream an InputStream
#'
#' @return A [Message]
#' @export
read_message <- function(stream) {
UseMethod("read_message")
Expand Down
18 changes: 15 additions & 3 deletions r/man/Message.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions r/man/read_message.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.