Commit 2cc8715
doc: document make lint-md-clean
Signed-off-by: Matteo Collina <hello@matteocollina.com>
PR-URL: #47926
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 3bf2bd4 commit 2cc8715
1 file changed
Lines changed: 3 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -85,6 +85,9 @@ for the error code should be added to the `doc/api/errors.md` file. This will | |||
| 85 | 85 | give users a place to go to easily look up the meaning of individual error | |
| 86 | 86 | codes. | |
| 87 | 87 | ||
| 88 | + In case `make lint` fails to detect the new error codes added into `errors.md`, | ||
| 89 | + the markdown linting cache must be cleaned with `make lint-md-clean`. | ||
| 90 | + | ||
| 88 | 91 | ## Testing new errors | |
| 89 | 92 | ||
| 90 | 93 | When adding a new error, corresponding test(s) for the error message | |
0 commit comments