Skip to content

Commit

Permalink
doc: document make lint-md-clean
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
mcollina authored and MoLow committed Jul 6, 2023
1 parent 3bf2bd4 commit 2cc8715
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/contributing/using-internal-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ for the error code should be added to the `doc/api/errors.md` file. This will
give users a place to go to easily look up the meaning of individual error
codes.

In case `make lint` fails to detect the new error codes added into `errors.md`,
the markdown linting cache must be cleaned with `make lint-md-clean`.

## Testing new errors

When adding a new error, corresponding test(s) for the error message
Expand Down

0 comments on commit 2cc8715

Please sign in to comment.