This is an automated email from the ASF dual-hosted git repository.
npr 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 1ecfb31b7d GH-43665: [R] Remove references to bindings vignette
(#43889)
1ecfb31b7d is described below
commit 1ecfb31b7dcebc486f404bc0ed74c1cf644bb51b
Author: Neal Richardson <[email protected]>
AuthorDate: Sun Sep 1 19:17:42 2024 -0400
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 b5905af654..5b598ab129 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
<https://arrow.apache.org/docs/r/articles/developing.html>`_
-- `Writing Bindings article for R package
<https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
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 0c194ab3a3..c4ea61d89f 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
<https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
diff --git a/docs/source/developers/guide/tutorials/r_tutorial.rst
b/docs/source/developers/guide/tutorials/r_tutorial.rst
index 62d5cfcbc7..3fba873bff 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()
<https://arrow.apache.org/docs/cpp/compute.html#containment-tests>`_
-to the (base) R function ``startsWith()``.
-
-To view the tutorial follow the
-`Walkthrough section of the Writing Bindings article
<https://arrow.apache.org/docs/r/articles/developers/bindings.html#walkthrough>`_.
-
-
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
<https://arrow.apache.org/docs/r/articles/developers/bindings.html>`_.
-
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
<https://arrow.apache.org/docs/r/articles/developers/bindings.html#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:
`<https://github.com/apache/arrow/blob/658bec37aa5cbdd53b5e4cdc81b8ba3962e67f11/r/R/expression.R#L63-L64>`_
diff --git a/r/vignettes/developing.Rmd b/r/vignettes/developing.Rmd
index 248a80292a..147f9cc028 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)
-
-
