bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Only emit warnings if the user is using Pulldown

Browse source 
Also checks for differences after eliminating whitespace-only diffs.

Renames get_html_diff
This commit is contained in:
Nick Cameron 2017-09-01 11:22:18 +12:00
parent 97b01abf3d
commit a5f50a9dee
1 changed files with 32 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

57
src/librustdoc/html/render.rs
View file

@ -1645,30 +1645,37 @@ fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Re
Ok(()) Ok(())
} }
fn get_html_diff(w: &mut fmt::Formatter, md_text: &str, render_type: RenderType, fn render_markdown(w: &mut fmt::Formatter, md_text: &str, render_type: RenderType,
prefix: &str) -> fmt::Result { prefix: &str) -> fmt::Result {
let output = format!("{}", Markdown(md_text, render_type)); let hoedown_output = format!("{}", Markdown(md_text, RenderType::Hoedown));
let old = format!("{}", Markdown(md_text, match render_type { // We only emit warnings if the user has opted-in to Pulldown rendering.
RenderType::Hoedown => RenderType::Pulldown, let output = if render_type == RenderType::Pulldown {
RenderType::Pulldown => RenderType::Hoedown, let pulldown_output = format!("{}", Markdown(md_text, RenderType::Pulldown));
})); let differences = html_diff::get_differences(&pulldown_output, &hoedown_output);
let differences = html_diff::get_differences(&output, &old); let differences = differences.iter()
if !differences.is_empty() { .filter_map(|s| {
println!("Differences spotted in {:?}:\n{}", match *s {
md_text, html_diff::Difference::NodeText { ref elem_text,
differences.iter() ref opposite_elem_text,
.filter_map(|s| { .. }
match *s { if elem_text.trim() == opposite_elem_text.trim() => None,
html_diff::Difference::NodeText { ref elem_text, _ => Some(format!("=> {}", s.to_string())),
ref opposite_elem_text, }
.. } })
if elem_text.trim() == opposite_elem_text.trim() => None, .collect::<Vec<String>>();
_ => Some(format!("=> {}", s.to_string())),
} if !differences.is_empty() {
}) // Emit warnings if there are differences.
.collect::<Vec<String>>() println!("Differences spotted in {:?}:\n{}",
.join("\n")); md_text,
} differences.join("\n"));
}
pulldown_output
} else {
hoedown_output
};
write!(w, "<div class='docblock'>{}{}</div>", prefix, output) write!(w, "<div class='docblock'>{}{}</div>", prefix, output)
} }
@ -1681,7 +1688,7 @@ fn document_short(w: &mut fmt::Formatter, item: &clean::Item, link: AssocItemLin
} else { } else {
format!("{}", &plain_summary_line(Some(s))) format!("{}", &plain_summary_line(Some(s)))
}; };
get_html_diff(w, &markdown, render_type, prefix)?; render_markdown(w, &markdown, render_type, prefix)?;
} else if !prefix.is_empty() { } else if !prefix.is_empty() {
write!(w, "<div class='docblock'>{}</div>", prefix)?; write!(w, "<div class='docblock'>{}</div>", prefix)?;
} }
@ -1705,7 +1712,7 @@ fn render_assoc_const_value(item: &clean::Item) -> String {
fn document_full(w: &mut fmt::Formatter, item: &clean::Item, fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
render_type: RenderType, prefix: &str) -> fmt::Result { render_type: RenderType, prefix: &str) -> fmt::Result {
if let Some(s) = item.doc_value() { if let Some(s) = item.doc_value() {
get_html_diff(w, s, render_type, prefix)?; render_markdown(w, s, render_type, prefix)?;
} else if !prefix.is_empty() { } else if !prefix.is_empty() {
write!(w, "<div class='docblock'>{}</div>", prefix)?; write!(w, "<div class='docblock'>{}</div>", prefix)?;
} }