Clarify lintr hook documentation and fix argument names #648
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Arguments were listed with
-instead of_, which is inconsistent with the actual hook implementation (see lintr.R).This also clarifies what the
--load_packageargument does and when it should be used.As an improvement, the default hook generation could include
--load_packagefor {lintr} by default, and suggest that users callsnippet_generate("additional-deps-lintr"), similar to how theroxygenizehook works.For context, see the related issue: #647.