diff options
| author | Eric Huss <eric@huss.org> | 2020-05-27 09:26:28 -0700 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2020-05-27 20:33:46 -0500 |
| commit | febe73f26af2bfe8d5d7c3d370c739b388a18275 (patch) | |
| tree | 6d0b22709e6ad963cd8410198cbca7f01409052e /src/doc/rustc-dev-guide | |
| parent | 8d7e1900ec5dee0efc25257424a4f0b61b2fc929 (diff) | |
| download | rust-febe73f26af2bfe8d5d7c3d370c739b388a18275.tar.gz rust-febe73f26af2bfe8d5d7c3d370c739b388a18275.zip | |
Apply suggestions from code review
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com> Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/diagnostics.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/diagnostics.md b/src/doc/rustc-dev-guide/src/diagnostics.md index adcf598d565..de081bb2067 100644 --- a/src/doc/rustc-dev-guide/src/diagnostics.md +++ b/src/doc/rustc-dev-guide/src/diagnostics.md @@ -75,7 +75,7 @@ The descriptions are written in markdown, and all of them are linked in the <!-- TODO: When should an error use an error code, and when shouldn't it? --> -[`librustc_error_codes`]: https://github.com/rust-lang/rust/blob/master/src/librustc_error_codes/error_codes.rs +[`librustc_error_codes`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_error_codes/error_codes/index.html [error index]: https://doc.rust-lang.org/error-index.html [RFC 1567]: https://github.com/rust-lang/rfcs/blob/master/text/1567-long-error-codes-explanation-normalization.md @@ -104,7 +104,7 @@ use an error-level lint instead of a fixed error. flag. That said, don't make it so terse that it's hard to understand. - The word "illegal" is illegal. Prefer "invalid" or a more specific word instead. -- Errors should document the span of code where they occur – the `span_..` +- Errors should document the span of code where they occur – the `librustc_errors::diagnostic_builder::DiagnosticBuilder` `span_*` methods allow to easily do this. Also `note` other spans that have contributed to the error if the span isn't too large. - When emitting a message with span, try to reduce the span to the smallest |
