Skip to content

Commit f36ad76

Browse files
committed
Update docs with new "root" argument
1 parent 96977b3 commit f36ad76

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

vignettes/available-hooks.Rmd

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,22 @@ This hook does not modify input files, but writes to `.Rd` files in
223223
`man/`, `NAMESPACE` and potentially others depending on which roxygen
224224
roclets you specified in `DESCRIPTION`.
225225

226+
227+
**Arguments**
228+
229+
<!-- -->
230+
231+
id: roxygenize
232+
args: [--root=<R package root>]
233+
234+
235+
- Argument `root` specifies the directory in the git repo that
236+
contains the R package. Defaults to `.` since for most R package git
237+
repos, the git and R package root coincide. Added in version
238+
0.3.3.00000.
239+
240+
241+
226242
## `deps-in-desc`
227243

228244
Checks if packages used with the `pkgname::fun()` syntax are listed in
@@ -248,7 +264,7 @@ your DESCRIPTION file. Note that `README.Rmd` is never checked.
248264
<!-- -->
249265

250266
id: deps-in-desc
251-
args: [--root=<R package root>]
267+
args: [--root=<R package root>]
252268

253269
This hook does not modify the file `DESCRIPTION` because the user should
254270
decide for each package if it should go to `Imports:` or `Suggests:`,
@@ -261,6 +277,19 @@ are ordered alphabetically and fields are in standard order.
261277

262278
This hook does modify the file `DESCRIPTION`.
263279

280+
**Arguments**
281+
282+
<!-- -->
283+
284+
id: use-tidy-description
285+
args: [--root=<R package root>]
286+
287+
288+
- Argument `root` specifies the directory in the git repo that
289+
contains the R package. Defaults to `.` since for most R package git
290+
repos, the git and R package root coincide. Added in version
291+
0.3.3.00000.
292+
264293
## `lintr`
265294

266295
A hook to run `lintr::lint()` to check that R files are lint free.
@@ -288,3 +317,16 @@ i.e. remind you to run `codemetar::write_codemeta()` in order to keep
288317
`codemeta.json` in sync with `DESCRIPTION`.
289318

290319
This hook does not modify any file.
320+
321+
**Arguments**
322+
323+
<!-- -->
324+
325+
id: codemeta-description-updated
326+
args: [--root=<R package root>]
327+
328+
329+
- Argument `root` specifies the directory in the git repo that
330+
contains the R package. Defaults to `.` since for most R package git
331+
repos, the git and R package root coincide. Added in version
332+
0.3.3.00000.

0 commit comments

Comments
 (0)