Fixed review comments

This commit is contained in:
Roman Stoliar 2019-07-30 21:25:51 +03:00
parent 1c11d7b1d8
commit facc7a35a5

View file

@ -2,7 +2,7 @@ pub(crate) fn format_docs(src: &str) -> String {
let mut processed_lines = Vec::new(); let mut processed_lines = Vec::new();
let mut in_code_block = false; let mut in_code_block = false;
for line in src.lines() { for line in src.lines() {
if in_code_block && line.trim_start().starts_with("# ") { if in_code_block && code_line_ignored_by_rustdoc(line) {
continue; continue;
} }
@ -21,6 +21,11 @@ pub(crate) fn format_docs(src: &str) -> String {
processed_lines.join("\n") processed_lines.join("\n")
} }
fn code_line_ignored_by_rustdoc(line: &str) -> bool {
let trimmed = line.trim();
trimmed == "#" || trimmed.starts_with("# ") || trimmed.starts_with("#\t")
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
@ -33,13 +38,14 @@ mod tests {
#[test] #[test]
fn test_format_docs_skips_comments_in_rust_block() { fn test_format_docs_skips_comments_in_rust_block() {
let comment = "```rust\n # skip1\n# skip2\n#stay1\nstay2\n```"; let comment =
"```rust\n # skip1\n# skip2\n#stay1\nstay2\n#\n #\n # \n #\tskip3\n\t#\t\n```";
assert_eq!(format_docs(comment), "```rust\n#stay1\nstay2\n```"); assert_eq!(format_docs(comment), "```rust\n#stay1\nstay2\n```");
} }
#[test] #[test]
fn test_format_docs_keeps_comments_outside_of_rust_block() { fn test_format_docs_keeps_comments_outside_of_rust_block() {
let comment = " # stay1\n# stay2\n#stay3\nstay4"; let comment = " # stay1\n# stay2\n#stay3\nstay4\n#\n #\n # \n #\tstay5\n\t#\t";
assert_eq!(format_docs(comment), comment); assert_eq!(format_docs(comment), comment);
} }
} }