Skip to content

Commit 6fbbb92

Browse files
Apply suggestions from code review
Co-authored-by: Lorenz Walthert <[email protected]>
1 parent d5d0926 commit 6fbbb92

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

vignettes/available-hooks.Rmd

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,18 @@ This means each file will be parsed, but code will not be evaluated - neither
153153
any explicit code in the file, nor any `@eval` tags within roxygen comments.
154154
This can be useful if your files contain anything other than
155155
"simple object declarations" (e.g. [box modules](https://github.com/klmr/box/)
156-
containing `box::use()` calls).
156+
containing `box::use()` calls). When `--no-eval` is missing, this means dependencies
157+
of the code to evaluate must be available for pre-commit. You may list these as
158+
`additional_dependencies:` for the `parsable-roxygen` hook in
159+
`.pre-commit-config.yaml`.
157160

158161
Inline R code within roxygen comments (i.e. within backticks) is **not**
159-
evaluated by this hook, whether or not `--no-eval` is specified.
162+
evaluated by this hook, whether or not `--no-eval` is specified. You would need to run the `roxygenize` hook for that.
160163

161164
id: parsable-roxygen
162165
args: [--no-eval]
163166

164-
167+
This hook was added in version 0.4.3.9000.
165168
## `no-browser-statement`
166169

167170
Guarantees you that you don't accidentally commit code with a

0 commit comments

Comments
 (0)