about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2022-05-11 07:26:28 +0000
committerbors <bors@rust-lang.org>2022-05-11 07:26:28 +0000
commitbe770a78a2bd6b2ec87a9442f60110b5aabbf6ce (patch)
treea21faecf2692559c3ced313beeaa97d7b69798b9
parentb350a1bf6f0bffe19b1bb64ae465188ff6f35d6d (diff)
parent2298a762221b329f7f34b2a7b62657a9820e8a26 (diff)
downloadrust-be770a78a2bd6b2ec87a9442f60110b5aabbf6ce.tar.gz
rust-be770a78a2bd6b2ec87a9442f60110b5aabbf6ce.zip
Auto merge of #12212 - Elliot-Roberts:hint_typo, r=lnicola
Fix a typo in the `inlayHints.renderColons` option description

The description said the same thing twice: "trailing colons for parameter hints, and trailing colons for parameter hints".
I'm assuming one of those is supposed to be about the leading colon for type hints.

Also, I wasn't sure how to regenerate the generated file(s?) so I just manually updated them. Hopefully that isn't a problem. If how to do that is in the documentation somewhere I'd love to know.
-rw-r--r--crates/rust-analyzer/src/config.rs2
-rw-r--r--docs/user/generated_config.adoc2
-rw-r--r--editors/code/package.json2
3 files changed, 3 insertions, 3 deletions
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs
index 119b94f060b..5da4417b771 100644
--- a/crates/rust-analyzer/src/config.rs
+++ b/crates/rust-analyzer/src/config.rs
@@ -264,7 +264,7 @@ config_data! {
         inlayHints_parameterHints_enable: bool                     = "true",
         /// Whether to show inlay type hints for compiler inserted reborrows.
         inlayHints_reborrowHints_enable: bool                      = "false",
-        /// Whether to render trailing colons for parameter hints, and trailing colons for parameter hints.
+        /// Whether to render leading colons for type hints, and trailing colons for parameter hints.
         inlayHints_renderColons: bool                              = "true",
         /// Whether to show inlay type hints for variables.
         inlayHints_typeHints_enable: bool                          = "true",
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index bc513601a80..0fad96dbcfe 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -373,7 +373,7 @@ Whether to show inlay type hints for compiler inserted reborrows.
 [[rust-analyzer.inlayHints.renderColons]]rust-analyzer.inlayHints.renderColons (default: `true`)::
 +
 --
-Whether to render trailing colons for parameter hints, and trailing colons for parameter hints.
+Whether to render leading colons for type hints, and trailing colons for parameter hints.
 --
 [[rust-analyzer.inlayHints.typeHints.enable]]rust-analyzer.inlayHints.typeHints.enable (default: `true`)::
 +
diff --git a/editors/code/package.json b/editors/code/package.json
index 515ecd0295a..241cafd369a 100644
--- a/editors/code/package.json
+++ b/editors/code/package.json
@@ -814,7 +814,7 @@
                     "type": "boolean"
                 },
                 "rust-analyzer.inlayHints.renderColons": {
-                    "markdownDescription": "Whether to render trailing colons for parameter hints, and trailing colons for parameter hints.",
+                    "markdownDescription": "Whether to render leading colons for type hints, and trailing colons for parameter hints.",
                     "default": true,
                     "type": "boolean"
                 },