thisisnic commented on a change in pull request #11921:
URL: https://github.com/apache/arrow/pull/11921#discussion_r781995880
##########
File path: r/vignettes/developers/workflow.Rmd
##########
@@ -4,6 +4,22 @@
knitr::opts_chunk$set(error = TRUE, eval = FALSE)
```
+The Arrow R package uses several additional development tools:
+
+* `lintr` for code analysis
+ - for the time being, the R package uses a custom version of lintr -
`jonkeane/lintr@arrow-branch`
+* `styler` for code styling
+* `pkgdown` for building the website
+* `roxygen2` for documenting the package
Review comment:
I really like how you've mentioned the packages up-front here; how about
also adding links to their pkgdown sites when you click on their names?
##########
File path: r/vignettes/developers/workflow.Rmd
##########
@@ -34,7 +44,7 @@ pkgdown::build_site(preview=TRUE)
The R code in the package follows [the tidyverse
style](https://style.tidyverse.org/). On PR submission (and on pushes) our CI
will run linting and will flag possible errors on the pull request with
annotations.
-To run the [lintr](https://github.com/jimhester/lintr) locally, install the
lintr package (note, we currently use a fork that includes fixes not yet
accepted upstream, see how lintr is being installed in the file
`ci/docker/linux-apt-lint.dockerfile` for the current status) and then run
+To run the [lintr](https://github.com/r-lib/lintr) locally, install the lintr
package (note, we currently use a fork that includes fixes not yet accepted
upstream, see how lintr is being installed in the file
`ci/docker/linux-apt-lint.dockerfile` for the current status) and then run
Review comment:
```suggestion
To run the [lintr](https://github.com/r-lib/lintr) locally, install the
lintr package (note, we currently use a fork that includes fixes not yet
accepted upstream; see how lintr is being installed in the file
`ci/docker/linux-apt-lint.dockerfile` for the current status) and then run
```
--
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]
