From 451f93860ba458242cb1221b728203839ba6ff6a Mon Sep 17 00:00:00 2001 From: Alenka Frim Date: Wed, 22 Dec 2021 12:10:56 +0100 Subject: [PATCH 1/2] Add a tab for R bindings and a link to the bindings vignette --- .../guide/step_by_step/arrow_codebase.rst | 24 ++++++++++++++----- 1 file changed, 18 insertions(+), 6 deletions(-) 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 7322ade80959..266b74823993 100644 --- a/docs/source/developers/guide/step_by_step/arrow_codebase.rst +++ b/docs/source/developers/guide/step_by_step/arrow_codebase.rst @@ -139,11 +139,23 @@ C++ we must create the binding manually to use it in that implementation. This also holds true for adding a test for the issue you have solved. - .. tab:: R package + **New feature** - .. - **Philosophy behind R bindings** - .. TODO + If you are adding a new future in Python you can look at + the :ref:`tutorial ` for ideas. - .. #. New feature - .. If you are adding a new future in R or Python you can check out - .. our tutorials (link!) where we are adding a simple feature to Python and R. \ No newline at end of file + .. tab:: R + + **Philosophy behind R bindings** + + 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 `_ + or run the following command in the R console to view the vignette: + + .. code-block:: R + + vignette("bindings", package = "arrow") From 8f116f2b28261e0882a3fad55049fb542d926e74 Mon Sep 17 00:00:00 2001 From: Alenka Frim Date: Thu, 23 Dec 2021 12:33:50 +0100 Subject: [PATCH 2/2] Remove the option to load a vignette --- .../developers/guide/step_by_step/arrow_codebase.rst | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) 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 266b74823993..c5fad4a8dee9 100644 --- a/docs/source/developers/guide/step_by_step/arrow_codebase.rst +++ b/docs/source/developers/guide/step_by_step/arrow_codebase.rst @@ -153,9 +153,4 @@ C++ we must create the binding manually to use it in that implementation. existing R functions. To read the full content on the topic of R bindings read through the - `Writing Bindings article `_ - or run the following command in the R console to view the vignette: - - .. code-block:: R - - vignette("bindings", package = "arrow") + `Writing Bindings article `_.