new chapter with examples of diagnostic translation PRs #1621
Conversation
tshepang
force-pushed
the
howto-translate
branch
from
bbafcf2
to
7a1313c
Compare
JohnTitor
added
the
S-waiting-on-review
tshepang
force-pushed
the
howto-translate
branch
from
7a1313c
to
78c3edc
Compare
| ecx.struct_span_err(span, "proc-macro derive produced unparseable tokens").emit(); | ||
| ``` | ||
|
|
||
| > Note that `ecx.struct_span_err` is the [Session::struct_span_err]. |
There was a problem hiding this comment.
| > Note that `ecx.struct_span_err` is the [Session::struct_span_err]. | |
| > Note that `ecx.struct_span_err` calls [Session::struct_span_err]. |
This should also probably link to ecx.struct_span_err (https://doc.rust-lang.org/nightly/nightly-rustc/rustc_expand/base/struct.ExtCtxt.html#method.struct_span_err) so that users can attest this relationship themselves.
There was a problem hiding this comment.
yeah, that should have been ultimately calls...
| - Replace the code above with this: | ||
|
|
||
| ```rust | ||
| ecx.sess.emit_err(errors::ProcMacroDeriveTokens { span }); |
There was a problem hiding this comment.
Should point to emit_err in rustdocs. Also, useful to point out that if the user wants to make a diagnostic, but not emit it, they can use create_err.
There was a problem hiding this comment.
tough balance between adding useful info and avoiding the overwhelm... I should find a way to fit create_err in the reference
| ecx.sess.emit_err(errors::ProcMacroDeriveTokens { span }); | ||
| ``` | ||
|
|
||
| - Create the above type, `errors::ProcMacroDeriveTokens`, |
There was a problem hiding this comment.
| - Create the above type, `errors::ProcMacroDeriveTokens`, | |
| - Add a diagnostic struct, `errors::ProcMacroDeriveTokens`, |
| Referring to the [general comments](#general-comments) section above, | ||
| follow these changes: | ||
|
|
||
| - Replace the code above with this: |
There was a problem hiding this comment.
| - Replace the code above with this: | |
| - Replace the calls to `struct_span_err` and `emit` with: |
| #[derive(Diagnostic)] | ||
| #[diag(expand_proc_macro_derive_tokens)] | ||
| pub struct ProcMacroDeriveTokens { | ||
| #[primary_span] |
There was a problem hiding this comment.
I think it may be useful to motivate the three important parts of this:
derive(Diagnostic)diag(FLUENT_SLUG)- and
primary_span
Maybe why we need these three components, what other components are common, etc?
There was a problem hiding this comment.
I more wanted to have people see the pattern, than do wall-of-text which can overwhelm. The more complete details are in the reference chapters (earlier in the guide).
Co-authored-by: Michael Goulet <michael@errs.io>
tshepang
added
S-waiting-on-author
|
@compiler-errors do you think this is fine to merge now?. |
|
Update: cf rust-lang/rust#132181 (diag infra currently in limbo, no longer mandatory usage, but examples/clarifications will still be very helpful) |
jieyouxu
added
A-diagnostics
I found other examples overwhelming, as they tend to handle large parts of rustc crates, so decided to point to these more simple ones I created.