Skip to content

Commit f41f762

Browse files
Merge pull request #20718 from ChayimFriedman2/inlay-max-len-docs
minor: Clarify `rust-analyzer.inlayHints.maxLength` is not a hard guarantee
2 parents e7d7cb4 + 129d9f7 commit f41f762

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

crates/rust-analyzer/src/config.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,8 @@ config_data! {
267267
inlayHints_lifetimeElisionHints_useParameterNames: bool = false,
268268

269269
/// Maximum length for inlay hints. Set to null to have an unlimited length.
270+
///
271+
/// **Note:** This is mostly a hint, and we don't guarantee to strictly follow the limit.
270272
inlayHints_maxLength: Option<usize> = Some(25),
271273

272274
/// Show function parameter name inlay hints at the call site.

docs/book/src/configuration_generated.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,8 @@ Default: `25`
10461046

10471047
Maximum length for inlay hints. Set to null to have an unlimited length.
10481048

1049+
**Note:** This is mostly a hint, and we don't guarantee to strictly follow the limit.
1050+
10491051

10501052
## rust-analyzer.inlayHints.parameterHints.enable {#inlayHints.parameterHints.enable}
10511053

editors/code/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2355,7 +2355,7 @@
23552355
"title": "Inlay Hints",
23562356
"properties": {
23572357
"rust-analyzer.inlayHints.maxLength": {
2358-
"markdownDescription": "Maximum length for inlay hints. Set to null to have an unlimited length.",
2358+
"markdownDescription": "Maximum length for inlay hints. Set to null to have an unlimited length.\n\n**Note:** This is mostly a hint, and we don't guarantee to strictly follow the limit.",
23592359
"default": 25,
23602360
"type": [
23612361
"null",

0 commit comments

Comments
 (0)