Skip to content

Commit ed1ac97

Browse files
better structure
1 parent 349dd2d commit ed1ac97

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

vignettes/hook-order.Rmd

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,30 @@ knitr::opts_chunk$set(
1414
)
1515
```
1616

17-
```{r setup}
18-
library(edison.infra)
19-
```
17+
Read only hooks should generally run only after write hooks.
18+
19+
## Rules for editing this document
20+
21+
- Only add a dependency once, i.e. if styler must run before roxygen, add the
22+
requirement to styler or roxygen, not both. This makes keeping track easier.
23+
- The hooks must appear in an order that meets all constraints, not just
24+
randomly order constraints.
2025

21-
Hooks with dependencies:
2226

23-
Read and write:
27+
## Hooks with dependencies:
28+
29+
**Read and write**
2430

2531
- styler: should run before roxygen because of caching. Caches.
2632
- roxygen. Caches.
2733
- codemeta: must be before tidy description.
2834
- use-tidy-description.
2935

30-
Just read:
36+
**Just read:**
3137

3238
- spell check; run after roxygen
3339
- lintr: should run after styler.
3440
- readme-rmd-rendered: Must run after styler.
3541
- parsable-R
3642
- no-browser-statement
3743
- deps in desc.
38-
39-
Read only hooks should generally run only after write hooks.

0 commit comments

Comments
 (0)