From c7d5afedc5d0a0185ee495028032ad650d62fe8b Mon Sep 17 00:00:00 2001 From: Xiaobo Liu Date: Thu, 9 Oct 2025 01:20:50 +0800 Subject: [PATCH] docs: Add missing docs for CommandInterceptResult fields (#39676) Document the `string` and `positions` fields to resolve TODO comments. Release Notes: - N/A Signed-off-by: Xiaobo Liu --- crates/command_palette_hooks/src/command_palette_hooks.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/crates/command_palette_hooks/src/command_palette_hooks.rs b/crates/command_palette_hooks/src/command_palette_hooks.rs index f1344c5ba6d46fce966ace60d483e3c0fc717f80..4923b811c570ea9413ff1e9c94aba4fbf1205a2b 100644 --- a/crates/command_palette_hooks/src/command_palette_hooks.rs +++ b/crates/command_palette_hooks/src/command_palette_hooks.rs @@ -97,11 +97,10 @@ impl CommandPaletteFilter { pub struct CommandInterceptResult { /// The action produced as a result of the interception. pub action: Box, - // TODO: Document this field. - #[allow(missing_docs)] + /// The display string to show in the command palette for this result. pub string: String, - // TODO: Document this field. - #[allow(missing_docs)] + /// The character positions in the string that match the query. + /// Used for highlighting matched characters in the command palette UI. pub positions: Vec, }