Skip to content

Commit

Permalink
tweak roxygen part
Browse files Browse the repository at this point in the history
  • Loading branch information
IndrajeetPatil committed Oct 1, 2024
1 parent 8705a34 commit 2a60865
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion paper/paper.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ A linter is a tool that analyzes code to identify potential errors, stylistic is

# Features

By default, `{lintr}` enforces the tidyverse style guide [@Wickham2023,@Müller2024]. In this respect, it differs from other static code analysis tools in R (like `{codetools}` [@Tierney2024]), which are not opinionated and don't enforce any particular style of writing code, but, rather, check R code for possible problems (incidentally, `{lintr}` uses `{codetools}` as a backend for object usage linters). Additionally, `{lintr}` doesn't cover linting inline code for documentation generation (cf. `{roxylint}` [@Kelkhoff2024] for linting `{roxygen2}` comments [@Wickham2024roxy]).
By default, `{lintr}` enforces the tidyverse style guide [@Wickham2023,@Müller2024]. In this respect, it differs from other static code analysis tools in R (like `{codetools}` [@Tierney2024]), which are not opinionated and don't enforce any particular style of writing code, but, rather, check R code for possible problems (incidentally, `{lintr}` uses `{codetools}` as a backend for object usage linters). Additionally, `{lintr}` is concerned only with R code, so code-adjacent text like inline `{roxygen2}` comments [@Wickham2024roxy] will not be covered (cf. `{roxylint}` [@Kelkhoff2024]).

As of this writing, `{lintr}` offers `r length(all_linters())` linters.

Expand Down
9 changes: 5 additions & 4 deletions paper/paper.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Static Code Analysis for R"
date: "2024-09-29"
date: "2024-10-01"
tags: ["R", "linter", "tidyverse"]
authors:
- name: Jim Hester
Expand Down Expand Up @@ -72,9 +72,10 @@ static code analysis tools in R (like `{codetools}` [@Tierney2024]),
which are not opinionated and don't enforce any particular style of
writing code, but, rather, check R code for possible problems
(incidentally, `{lintr}` uses `{codetools}` as a backend for object
usage linters). Additionally, `{lintr}` doesn't cover linting inline
code for documentation generation (cf. `{roxylint}` [@Kelkhoff2024] for
linting `{roxygen2}` comments [@Wickham2024roxy]).
usage linters). Additionally, `{lintr}` is concerned only with R code,
so code-adjacent text like inline `{roxygen2}` comments
[@Wickham2024roxy] will not be covered (cf. `{roxylint}`
[@Kelkhoff2024]).

As of this writing, `{lintr}` offers 113 linters.

Expand Down

0 comments on commit 2a60865

Please sign in to comment.