Correct suggestion for println #51614
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rust-highfive
added
the
S-waiting-on-review
varkor
reviewed
Jun 18, 2018
src/test/ui/macros/bad_hello.stderr
Outdated
| @@ -2,7 +2,7 @@ error: expected a literal | |||
| --> $DIR/bad_hello.rs:12:14 | |||
| | | |||
| LL | println!(3 + 4); //~ ERROR expected a literal | |||
| | ^^^^^ | |||
| | ^^^^^ help: consider changing this to: `"{}", 3 + 4` | |||
There was a problem hiding this comment.
I think this suggestion as-is could be a little confusing: selecting the entire expression and suggesting it be replaced with println!("{}", 3 + 4) would give more helpful context.
There was a problem hiding this comment.
An alternative to avoid having to play with the spans can be to make the help message long enough that it no longer is suggested in place, instead showing the new code on its own:
help: you might be missing a string literal to format with
|
LL | println!("{}", 3 + 4); //~ ERROR expected a literal
| ^^^^^^^^^^^
estebank
reviewed
Jun 19, 2018
src/libsyntax_ext/concat.rs
Outdated
| err.span_suggestion( | ||
| e.span, | ||
| "consider changing this to", | ||
| format!("\"{{}}\", {}", pprust::expr_to_string(&e)) |
There was a problem hiding this comment.
Could you use span to snippet here and only use expression to string only if that call fails? We want to preserve the code as is, like for example whitespace.
src/libsyntax_ext/concat.rs
Outdated
| "consider changing this to", | ||
| format!("\"{{}}\", {}", pprust::expr_to_string(&e)) | ||
| ); | ||
| err.emit(); |
There was a problem hiding this comment.
Could you add a note explaining that a format string is always needed?
pietroalbini
added
S-waiting-on-author
|
Ping form triage, @csmoe: It looks like there are some comments on your PR, do you think you'll be able to address those? |
|
@TimNN testing locally, more commits later. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
kennytm
added
S-waiting-on-review
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
This comment has been minimized.
This comment has been minimized.
|
Ping from triage, @estebank ! This PR requires your review. |
estebank
reviewed
Jul 10, 2018
src/libsyntax_ext/concat.rs
Outdated
| @@ -53,7 +53,12 @@ pub fn expand_syntax_ext(cx: &mut base::ExtCtxt, | |||
| } | |||
| } | |||
| _ => { | |||
| cx.span_err(e.span, "expected a literal"); | |||
| let mut err = cx.struct_span_err(e.span, "expected a literal"); | |||
| err.span_help( | |||
There was a problem hiding this comment.
This should be
if let Some(snippet) = cx.codemap().span_to_snippet(span) {
err.span_suggestion(
e.span,
"you might be missing a string literal to format with",
format!("\"{{}}\", {}", snippet);
);
}
Which will give you the following output:
error: expected a literal
--> $DIR/bad_hello.rs:12:14
|
LL | println!(3 + 4); //~ ERROR expected a literal
| ^^^^^
|
help: you might be missing a string literal to format with
--> $DIR/bad_hello.rs:12:14
|
LL | println!("{}", 3 + 4); //~ ERROR expected a literal
| ^^^^^^^^^^^
estebank
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
|
Oh, sorry, it is a |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
@bors r+ rollup |
|
📌 Commit 790c09e has been approved by |
bors
added
S-waiting-on-bors
Mark-Simulacrum
added a commit
to Mark-Simulacrum/rust
that referenced
this pull request
Jul 11, 2018
Correct suggestion for println Closes rust-lang#51585 r? @estebank
bors
added a commit
that referenced
this pull request
Jul 11, 2018
Rollup of 14 pull requests Successful merges: - #51614 (Correct suggestion for println) - #51952 ( hygiene: Decouple transparencies from expansion IDs) - #52193 (step_by: leave time of item skip unspecified) - #52207 (improve error message shown for unsafe operations) - #52223 (Deny bare trait objects in in src/liballoc) - #52224 (Deny bare trait objects in in src/libsyntax) - #52239 (Remove sync::Once::call_once 'static bound) - #52247 (Deny bare trait objects in in src/librustc) - #52248 (Deny bare trait objects in in src/librustc_allocator) - #52252 (Deny bare trait objects in in src/librustc_codegen_llvm) - #52253 (Deny bare trait objects in in src/librustc_data_structures) - #52254 (Deny bare trait objects in in src/librustc_metadata) - #52261 (Deny bare trait objects in in src/libpanic_unwind) - #52265 (Deny bare trait objects in in src/librustc_codegen_utils) Failed merges: r? @ghost
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #51585
r? @estebank