Skip to content

Commit b9c397a

Browse files
authored
docs(all): move information to preprocessors section (#2279)
1 parent fcd5f7d commit b9c397a

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

docs/@v1/configuration/reference/preprocessors.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
## Introduction
44

5-
Preprocessors are similar to decorators, but they run before linting rather than after.
5+
Preprocessors are similar to decorators and follow the same structure and operation, but they run before the validation/linting step rather than after.
6+
7+
Running before the validation/linting step makes them brittle because the document may not be valid, and the extra processing step can cause performance impacts. We recommend looking for alternative approaches to preprocessing.
8+
9+
Some advanced use cases do require preprocessing, which is why the functionality is provided for those users.
610

711
Refer to the [`decorator` configuration options](./decorators.md) documentation for details; the options available are the same in both the `decorators` and `preprocessor` sections of the configuration file.
812

docs/@v1/custom-plugins/custom-decorators.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,4 @@ decorators:
218218

219219
## Preprocessors
220220

221-
Preprocessors follow the same structure and operation as decorators, but they are run before the validation/linting step. Running before the validation/linting step makes them brittle because the document may not be valid, and the extra processing step can cause performance impacts. We recommend looking for alternative approaches to preprocessing.
222-
223-
Some advanced use cases do require preprocessing, which is why the functionality is provided for those users.
221+
For detailed information about preprocessors, see the [preprocessors configuration reference](../configuration/reference/preprocessors.md).

docs/@v2/configuration/reference/preprocessors.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
## Introduction
44

5-
Preprocessors are similar to decorators, but they run before linting rather than after.
5+
Preprocessors are similar to decorators and follow the same structure and operation, but they run before the validation/linting step rather than after.
6+
7+
Running before the validation/linting step makes them brittle because the document may not be valid, and the extra processing step can cause performance impacts. We recommend looking for alternative approaches to preprocessing.
8+
9+
Some advanced use cases do require preprocessing, which is why the functionality is provided for those users.
610

711
Refer to the [`decorator` configuration options](./decorators.md) documentation for details; the options available are the same in both the `decorators` and `preprocessor` sections of the configuration file.
812

docs/@v2/custom-plugins/custom-decorators.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,4 @@ decorators:
213213

214214
## Preprocessors
215215

216-
Preprocessors follow the same structure and operation as decorators, but they are run before the validation/linting step. Running before the validation/linting step makes them brittle because the document may not be valid, and the extra processing step can cause performance impacts. We recommend looking for alternative approaches to preprocessing.
217-
218-
Some advanced use cases do require preprocessing, which is why the functionality is provided for those users.
216+
For detailed information about preprocessors, see the [preprocessors configuration reference](../configuration/reference/preprocessors.md).

0 commit comments

Comments
 (0)