Unnamed repository; edit this file 'description' to name the repository.
Merge #11252
11252: Fix documentation of snippet r=Veykril a=weirane
Closes #11234
Co-authored-by: Wang Ruochen <[email protected]>
| -rw-r--r-- | crates/rust-analyzer/src/config.rs | 18 | ||||
| -rw-r--r-- | docs/user/generated_config.adoc | 13 |
2 files changed, 26 insertions, 5 deletions
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs index 88d86ef503..1df19ffe78 100644 --- a/crates/rust-analyzer/src/config.rs +++ b/crates/rust-analyzer/src/config.rs @@ -1364,7 +1364,23 @@ fn manual(fields: &[(&'static str, &'static str, &[&str], &str)]) -> String { .map(|(field, _ty, doc, default)| { let name = format!("rust-analyzer.{}", field.replace("_", ".")); let doc = doc_comment_to_string(*doc); - format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc) + if default.contains('\n') { + format!( + r#"[[{}]]{}:: ++ +-- +Default: +---- +{} +---- +{} +-- +"#, + name, name, default, doc + ) + } else { + format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc) + } }) .collect::<String>() } diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 88dcacfe83..f7a533c7c2 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -146,7 +146,12 @@ Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set. -- Whether to add parenthesis when completing functions. -- -[[rust-analyzer.completion.snippets]]rust-analyzer.completion.snippets (default: `{ +[[rust-analyzer.completion.snippets]]rust-analyzer.completion.snippets:: ++ +-- +Default: +---- +{ "Arc::new": { "postfix": "arc", "body": "Arc::new(${receiver})", @@ -186,10 +191,10 @@ Whether to add parenthesis when completing functions. "description": "Wrap the expression in an `Option::Some`", "scope": "expr" } - }`):: -+ --- + } +---- Custom completion snippets. + -- [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`):: + |