From 869507efbe64778a0249c8e7b73bfd81bfc4c84a Mon Sep 17 00:00:00 2001 From: Alenka Frim Date: Wed, 22 Dec 2021 11:44:22 +0100 Subject: [PATCH 1/2] Add a short intro and a link to the bindings vignette --- .../developers/guide/tutorials/r_tutorial.rst | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/source/developers/guide/tutorials/r_tutorial.rst b/docs/source/developers/guide/tutorials/r_tutorial.rst index 79905daacb2..6b35c3dccba 100644 --- a/docs/source/developers/guide/tutorials/r_tutorial.rst +++ b/docs/source/developers/guide/tutorials/r_tutorial.rst @@ -24,4 +24,26 @@ ********** R tutorial -********** \ No newline at end of file +********** + +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. + +Writing Bindings Walkthrough +---------------------------- + +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 +`this link `_ +or run the following command in the R console: + +.. code-block:: R + + vignette("bindings", package = "arrow") + +You will find the tutorial under the **Walkthrough** section. From 9b2df51d0a364c52268cd68faaba70817c4e03b5 Mon Sep 17 00:00:00 2001 From: Alenka Frim Date: Thu, 23 Dec 2021 12:31:43 +0100 Subject: [PATCH 2/2] Remove the option to load a vignette --- docs/source/developers/guide/tutorials/r_tutorial.rst | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/docs/source/developers/guide/tutorials/r_tutorial.rst b/docs/source/developers/guide/tutorials/r_tutorial.rst index 6b35c3dccba..dc5dd337c32 100644 --- a/docs/source/developers/guide/tutorials/r_tutorial.rst +++ b/docs/source/developers/guide/tutorials/r_tutorial.rst @@ -38,12 +38,5 @@ 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 -`this link `_ -or run the following command in the R console: - -.. code-block:: R - - vignette("bindings", package = "arrow") - -You will find the tutorial under the **Walkthrough** section. +To view the tutorial follow the +`Walkthrough section of the Writing Bindings article `_.