Further reading for no tabs linter (#1690)

* Further reading for no tabs linter Closes #1672 * leave out one ref Co-authored-by: Michael Chirico <[email protected]>
r-lib · Oct 12, 2022 · bed54c5 · bed54c5
1 parent 5ea4ca8
commit bed54c5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/R/no_tab_linter.R b/R/no_tab_linter.R
@@ -1,6 +1,9 @@
 #' No tab linter
 #'
-#' Check that only spaces are used for indentation, not tabs.
+#' Check that only spaces are used for indentation, not tabs. Much ink has been
+#' spilt on this topic, and we encourage you to check out references for more
+#' information.
+#'
 #' @include make_linter_from_regex.R
 #'
 #' @examples
@@ -18,6 +21,10 @@
 #'
 #' @evalRd rd_tags("no_tab_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
+#'
+#' @references
+#' - https://www.jwz.org/doc/tabs-vs-spaces.html
+#' - https://blog.codinghorror.com/death-to-the-space-infidels/
 #' @export
 no_tab_linter <- make_linter_from_regex(
   regex = rex(start, zero_or_more(regex("\\s")), one_or_more("\t")),

diff --git a/man/no_tab_linter.Rd b/man/no_tab_linter.Rd