diff options
| author | Taylor Cramer <cramertaylorj@gmail.com> | 2024-11-21 10:58:56 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-21 10:58:56 -0800 |
| commit | dd819cf4c7f57d4446cb0b66b8f2e25744dcce53 (patch) | |
| tree | b029c0506f573a92b78fefab1228c29b8461a4f8 | |
| parent | f6841a6fa3c6a2d951f49d884d73c68cbb8b3923 (diff) | |
| download | rust-dd819cf4c7f57d4446cb0b66b8f2e25744dcce53.tar.gz rust-dd819cf4c7f57d4446cb0b66b8f2e25744dcce53.zip | |
Add instructions to test error code docs (#2145)
| -rw-r--r-- | src/doc/rustc-dev-guide/src/diagnostics/error-codes.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/diagnostics/error-codes.md b/src/doc/rustc-dev-guide/src/diagnostics/error-codes.md index fc2fe190c20..1b6b87e4c8d 100644 --- a/src/doc/rustc-dev-guide/src/diagnostics/error-codes.md +++ b/src/doc/rustc-dev-guide/src/diagnostics/error-codes.md @@ -93,3 +93,12 @@ struct_span_code_err!(...) For an example of a PR adding an error code, see [#76143]. [#76143]: https://github.com/rust-lang/rust/pull/76143 + +## Running error code doctests + +To test the examples added in `rustc_error_codes/src/error_codes`, run the +error index generator using: + +``` +./x test ./src/tools/error_index_generator +``` |