Skip to content

Commit

Permalink
apacheGH-43665: [R] Remove references to bindings vignette (apache#43889
Browse files Browse the repository at this point in the history
)

### Rationale for this change

The writing-bindings vignette was removed in
apache#41576 (comment). 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: apache#43665
  • Loading branch information
nealrichardson authored and mapleFU committed Sep 3, 2024
1 parent 7c16d21 commit 36e51b5
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 35 deletions.
1 change: 0 additions & 1 deletion docs/source/developers/guide/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
3 changes: 0 additions & 3 deletions docs/source/developers/guide/step_by_step/arrow_codebase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
28 changes: 0 additions & 28 deletions docs/source/developers/guide/tutorials/r_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
========================================

Expand All @@ -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.
Expand Down Expand Up @@ -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>`_
Expand Down
3 changes: 0 additions & 3 deletions r/vignettes/developing.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)


0 comments on commit 36e51b5

Please sign in to comment.