From 36e51b5c2844ea30efa039f6bc70ea7b7da80d1b Mon Sep 17 00:00:00 2001 From: Neal Richardson Date: Sun, 1 Sep 2024 19:17:42 -0400 Subject: [PATCH] GH-43665: [R] Remove references to bindings vignette (#43889) ### Rationale for this change The writing-bindings vignette was removed in https://github.com/apache/arrow/pull/41576#issuecomment-2134327019. It turns out there were more references to it throughout the docs that I failed to remove ### What changes are included in this PR? Deleting x-refs that don't exist anymore. ### Are these changes tested? Not really ### Are there any user-facing changes? The docs won't point you at links that 404. * GitHub Issue: #43665 --- docs/source/developers/guide/resources.rst | 1 - .../guide/step_by_step/arrow_codebase.rst | 3 -- .../developers/guide/tutorials/r_tutorial.rst | 28 ------------------- r/vignettes/developing.Rmd | 3 -- 4 files changed, 35 deletions(-) diff --git a/docs/source/developers/guide/resources.rst b/docs/source/developers/guide/resources.rst index b5905af65499b..5b598ab1296ac 100644 --- a/docs/source/developers/guide/resources.rst +++ b/docs/source/developers/guide/resources.rst @@ -71,7 +71,6 @@ Contributing - :ref:`contributing` - `Arrow R Developer Guide `_ -- `Writing Bindings article for R package `_. Reproducible examples: diff --git a/docs/source/developers/guide/step_by_step/arrow_codebase.rst b/docs/source/developers/guide/step_by_step/arrow_codebase.rst index 0c194ab3a3f70..c4ea61d89ff80 100644 --- a/docs/source/developers/guide/step_by_step/arrow_codebase.rst +++ b/docs/source/developers/guide/step_by_step/arrow_codebase.rst @@ -150,6 +150,3 @@ C++ we must create the binding manually to use it in that implementation. When writing bindings between C++ compute functions and R functions, the aim is to expose the C++ functionality via the same interface as existing R functions. - - To read the full content on the topic of R bindings read through the - `Writing Bindings article `_. diff --git a/docs/source/developers/guide/tutorials/r_tutorial.rst b/docs/source/developers/guide/tutorials/r_tutorial.rst index 62d5cfcbc76c2..3fba873bff0a9 100644 --- a/docs/source/developers/guide/tutorials/r_tutorial.rst +++ b/docs/source/developers/guide/tutorials/r_tutorial.rst @@ -27,22 +27,6 @@ R tutorials *********** -Writing Bindings Walkthrough -============================ - -The first R package tutorial to be included in the New Contributor's -guide is a **Walkthrough** added in the **Writing Bindings** -vignette. With time we will try to include additional tutorials -directly into this guide. - -This tutorial will show how to do a binding of a C++ function -`starts_with() `_ -to the (base) R function ``startsWith()``. - -To view the tutorial follow the -`Walkthrough section of the Writing Bindings article `_. - - R tutorial on adding a lubridate binding ======================================== @@ -56,11 +40,6 @@ The binding will be added to the ``expression.R`` file in the R package. But you can also follow these steps in case you are adding a binding that will live somewhere else. -.. seealso:: - - To read more about the philosophy behind R bindings, refer to the - `Writing Bindings article `_. - This tutorial is different from the :ref:`step_by_step` as we will be working on a specific case. This tutorial is not meant as a step-by-step guide. @@ -170,13 +149,6 @@ equivalent data types. lubridate's ``mday()`` function has no additional arguments and there are also no option classes associated with Arrow C++ function ``day()``. -.. note:: - - To see what to do if there is an option class associated with the - function you are binding, refer to - `Examining the C++ function `_ from the Writing Bindings - article. - Looking at the code in ``expressions.R`` we can see the day function is already specified/mapped on the R package side: ``_ diff --git a/r/vignettes/developing.Rmd b/r/vignettes/developing.Rmd index 248a80292a029..147f9cc028d78 100644 --- a/r/vignettes/developing.Rmd +++ b/r/vignettes/developing.Rmd @@ -52,6 +52,3 @@ There are a number of ways in which we do this: * [Running R with the C++ debugger attached](https://arrow.apache.org/docs/r/articles/developers/debugging.html) * [In-depth guide to how the package installation works](https://arrow.apache.org/docs/r/articles/developers/install_details.html) * [Using Docker to diagnose a bug or test a feature on a specific OS](https://arrow.apache.org/docs/r/articles/developers/docker.html) -* [Writing bindings between R functions and Arrow Acero functions](https://arrow.apache.org/docs/r/articles/developers/bindings.html) - -