bendns' repos / rust-analyzer
Unnamed repository; edit this file 'description' to name the repository.
Fix: only shows one # when we encounter ##
Browse Source
Dezhi Wu 2021-10-20
parent 5051717 · commit b7b9cd5
Diffstat
-rw-r--r--crates/rust-analyzer/src/markdown.rs26
1 files changed, 23 insertions, 3 deletions
diff --git a/crates/rust-analyzer/src/markdown.rs b/crates/rust-analyzer/src/markdown.rs
index 35eaffba8c..9ffd085b0c 100644
--- a/crates/rust-analyzer/src/markdown.rs
+++ b/crates/rust-analyzer/src/markdown.rs
@@ -1,4 +1,6 @@
//! Transforms markdown
+use std::borrow::Cow;
+
use ide_db::helpers::rust_doc::is_rust_fence;
const RUSTDOC_FENCE: &str = "```";
@@ -8,8 +10,9 @@ pub(crate) fn format_docs(src: &str) -> String {
let mut in_code_block = false;
let mut is_rust = false;
- for mut line in src.lines() {
- if in_code_block && is_rust && code_line_ignored_by_rustdoc(line) {
+ for line in src.lines() {
+ let mut line = Cow::from(line);
+ if in_code_block && is_rust && code_line_ignored_by_rustdoc(&line) {
continue;
}
@@ -20,11 +23,18 @@ pub(crate) fn format_docs(src: &str) -> String {
is_rust = is_rust_fence(header);
if is_rust {
- line = "```rust";
+ line = Cow::Borrowed("```rust");
}
}
}
+ if in_code_block {
+ let trimmed = line.trim();
+ if trimmed.starts_with("##") {
+ line = Cow::Owned(line.replacen("##", "#", 1));
+ }
+ }
+
processed_lines.push(line);
}
processed_lines.join("\n")
@@ -136,4 +146,14 @@ let a = 1;
"```text\nfiller\ntext\n```\nSome comment.\n```rust\nlet a = 1;\n```"
);
}
+
+ #[test]
+ fn test_format_docs_handles_escape_double_hashes() {
+ let comment = r#"```rust
+let s = "foo
+## bar # baz";
+```"#;
+
+ assert_eq!(format_docs(comment), "```rust\nlet s = \"foo\n# bar # baz\";\n```");
+ }
}