thisisnic commented on a change in pull request #10930: URL: https://github.com/apache/arrow/pull/10930#discussion_r701018019
########## File path: r/vignettes/developing.Rmd ########## @@ -40,98 +38,125 @@ set -e set -x ``` -If you're looking to contribute to `arrow`, this document can help you set up a development environment that will enable you to write code and run tests locally. It outlines how to build the various components that make up the Arrow project and R package, as well as some common troubleshooting and workflows developers use. Many contributions can be accomplished with the instructions in [R-only development](#r-only-development). But if you're working on both the C++ library and the R package, the [Developer environment setup](#-developer-environment-setup) section will guide you through setting up a developer environment. +If you're looking to contribute to arrow, this vignette can help you set up a development environment that will enable you to write code and run tests locally. It outlines: + +* how to build the components that make up the Arrow project and R package +* some common troubleshooting and workflows that developers use + +This document is intended only for developers of Apache Arrow or the Arrow R package. Users of the package in R do not need to do any of this setup. If you're looking for how to install Arrow, see [the instructions in the readme](https://arrow.apache.org/docs/r/#installation). + +For clarity, a quick note on terminology used in this vignette: -This document is intended only for developers of Apache Arrow or the Arrow R package. Users of the package in R do not need to do any of this setup. If you're looking for how to install Arrow, see [the instructions in the readme](https://arrow.apache.org/docs/r/#installation); Linux users can find more details on building from source at `vignette("install", package = "arrow")`. +* "Apache Arrow" or "Arrow" - the Apache Arrow project, including implementations in different languages +* "libarrow" or "the Arrow C++ library" - Arrow's C++ library (N.B. this term might not be used in documentation in other parts of the Arrow project) +* "arrow" or "the Arrow R package" - the R package +* `arrow` - a directory into which the Arrow GitHub repo has been checked out Review comment: Good point - whilst writing this down was useful while I was working on the vignette, now that terminology is consistent, it's a little redundant. I'm not 100% on board with the info as a footnote as I think it's important to have it up front still, so what I think will satisfy all requirements here is just explain what `libarrow` is, in parentheses, after the first mention of the term, and then leave everything else to be implicit. The main point of doing this was the libarrow vs. arrow package distinction, so I think we've ticked those boxes now - though happy to adjust again if you think further changes are needed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
