user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve error display for codeblocks in rustdoc

Browse source
This commit is contained in:
Guillaume Gomez 2018-09-03 22:24:11 +02:00
parent 20dc0c5070
commit f7240e1c74
4 changed files with 55 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/librustdoc/html/highlight.rs
View file

@ -44,9 +44,21 @@ pub fn render_with_highlighting(src: &str, class: Option<&str>,
}
write_header(class, &mut out).unwrap();
let mut classifier = Classifier::new(lexer::StringReader::new(&sess, fm, None),
sess.source_map());
let lexer = match lexer::StringReader::new_without_err(&sess, fm, None) {
Ok(l) => l,
Err(_) => {
let first_line = src.lines().next().unwrap_or_else(|| "");
let mut err = sess.span_diagnostic
.struct_warn(&format!("Invalid doc comment starting with: `{}`\n\
(Ignoring this codeblock)",
first_line));
err.emit();
return String::new();
}
};
let mut classifier = Classifier::new(lexer, sess.source_map());
if classifier.write_source(&mut out).is_err() {
classifier.lexer.emit_fatal_errors();
return format!("<pre>{}</pre>", src);
}
@ -162,11 +174,10 @@ impl<'a> Classifier<'a> {
match self.lexer.try_next_token() {
Ok(tas) => Ok(tas),
Err(_) => {
self.lexer.emit_fatal_errors();
self.lexer.sess.span_diagnostic
.struct_warn("Backing out of syntax highlighting")
.note("You probably did not intend to render this as a rust code-block")
.emit();
let mut err = self.lexer.sess.span_diagnostic
.struct_warn("Backing out of syntax highlighting");
err.note("You probably did not intend to render this as a rust code-block");
err.emit();
Err(io::Error::new(io::ErrorKind::Other, ""))
}
}