Skip to content

Commit be17eba

Browse files
committed
Amend news and lintr config search description
Fixed the description based on review, performed very minor copy editing, and adapted formatting to be consistent.
1 parent 2a28c98 commit be17eba

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

NEWS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Deprecations & Breaking Changes
44

5-
* .lintr configs can now be kept in the directory .github/linters for better compatibility with Super-Linter. Note that this may be a breaking change if you already have a config in both such a directory and in your R project's root since the former will now be discovered first where it was ignored before. Please see vignette("lintr") for details on how configs are discovered. (#1746, @tonyk7440)
5+
* `.lintr` files can now be kept in the directory `.github/linters` for better compatibility with Super-Linter. Note that this may be a breaking change if you already have a config in `.github/linters` inside a subdirectory as well as in your R project's root, since the former will now be discovered first where it was ignored before. Please see `vignette("lintr")` for details on how configs are discovered (#1746, @tonyk7440 and @klmr).
66
* `single_quotes_linter()` is deprecated in favor of the more generalizable `quotes_linter()` (#1729, @MichaelChirico).
77
* `unneeded_concatentation_linter()` is deprecated in favor of `unnecessary_concatenation_linter()` for naming consistency (#1707, @IndrajeetPatil).
88
* `consecutive_stopifnot_linter()` is deprecated in favor of the more general (see below) `consecutive_assertion_linter()` (#1604, @MichaelChirico).

vignettes/lintr.Rmd

+3-3
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ exclusions: list(
9191
More generally, `lintr` searches for a settings file according to following prioritized list.
9292
The first one found, if any, will be used.
9393

94-
1. If `options(lintr.linter_file)` is an absolute path, this file will be used. The default for this option is `".lintr"`.
95-
2. A linter file (that is a file named like `lintr.linter_file`) in the currently searched directory, i.e. the directory of the file passed to `lint()`. When run from `lint_package()`, this directory can differ for each linted file.
96-
3. A linter file in the `.github/linters` child directory of the currently-searched directory.
94+
1. If `options("lintr.linter_file")` is an absolute path, this file will be used. The default for this option is `".lintr"`.
95+
2. A linter file (that is a file named like `lintr.linter_file`) in the currently-searched directory, i.e. the directory of the file passed to `lint()`, or in the closest parent directory. When run from `lint_package()`, this directory can differ for each linted file.
96+
3. A linter file in the `.github/linters` child directory of the currently-searched directory, or in the closest parent directory.
9797
4. A linter file in a parent directory of the currently-searched directory, starting from the deepest path, moving upwards one level at a time.
9898
5. A linter file in the user's `HOME` directory.
9999

0 commit comments

Comments
 (0)