docs: Correct action descriptions to reflect actual purpose (#46931)

Xin Zhao and Kunall Banerjee created 2 months ago

Thanks @injust for pointing this out. It seems a few other action docs
were also copied from elsewhere and weren't updated to reflect their
actual purpose. This PR fixes those, though I may not have covered all
of them.

Closes #46832

Release Notes:

- N/A

---------

Co-authored-by: Kunall Banerjee <[e-mail]>

Change summary

crates/debugger_ui/src/debugger_ui.rs | 3 +--
crates/vim/src/helix.rs               | 4 ++--
crates/vim/src/normal.rs              | 4 ++--
crates/vim/src/object.rs              | 9 +++++----
crates/zed_actions/src/lib.rs         | 4 ++--
5 files changed, 12 insertions(+), 12 deletions(-)

Detailed changes

crates/debugger_ui/src/debugger_ui.rs

@@ -90,11 +90,10 @@ actions!(
     ]
 );
 
-/// Extends selection down by a specified number of lines.
+/// Set a data breakpoint on the selected variable or memory region.
 #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
 #[action(namespace = debugger)]
 #[serde(deny_unknown_fields)]
-/// Set a data breakpoint on the selected variable or memory region.
 pub struct ToggleDataBreakpoint {
     /// The type of data breakpoint
     /// Read & Write

crates/vim/src/helix.rs

@@ -53,9 +53,9 @@ actions!(
         HelixSubstitute,
         /// Delete the selection and enter edit mode, without yanking the selection.
         HelixSubstituteNoYank,
-        /// Delete the selection and enter edit mode.
+        /// Select the next match for the current search query.
         HelixSelectNext,
-        /// Delete the selection and enter edit mode, without yanking the selection.
+        /// Select the previous match for the current search query.
         HelixSelectPrevious,
     ]
 );

crates/vim/src/normal.rs

@@ -100,9 +100,9 @@ actions!(
         GoToTab,
         /// Go to previous tab page (with count support).
         GoToPreviousTab,
-        /// Go to tab page (with count support).
+        /// Goes to the previous reference to the symbol under the cursor.
         GoToPreviousReference,
-        /// Go to previous tab page (with count support).
+        /// Goes to the next reference to the symbol under the cursor.
         GoToNextReference,
     ]
 );

crates/vim/src/object.rs

@@ -85,7 +85,7 @@ pub struct CandidateWithRanges {
     close_range: Range<MultiBufferOffset>,
 }
 
-/// Selects text at the same indentation level.
+/// Operates on text within or around parentheses `()`.
 #[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
 #[action(namespace = vim)]
 #[serde(deny_unknown_fields)]
@@ -94,7 +94,7 @@ struct Parentheses {
     opening: bool,
 }
 
-/// Selects text at the same indentation level.
+/// Operates on text within or around square brackets `[]`.
 #[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
 #[action(namespace = vim)]
 #[serde(deny_unknown_fields)]
@@ -103,7 +103,7 @@ struct SquareBrackets {
     opening: bool,
 }
 
-/// Selects text at the same indentation level.
+/// Operates on text within or around angle brackets `<>`.
 #[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
 #[action(namespace = vim)]
 #[serde(deny_unknown_fields)]
@@ -111,7 +111,8 @@ struct AngleBrackets {
     #[serde(default)]
     opening: bool,
 }
-/// Selects text at the same indentation level.
+
+/// Operates on text within or around curly brackets `{}`.
 #[derive(Clone, Deserialize, JsonSchema, PartialEq, Action)]
 #[action(namespace = vim)]
 #[serde(deny_unknown_fields)]

crates/zed_actions/src/lib.rs

@@ -128,7 +128,7 @@ pub struct IncreaseBufferFontSize {
     pub persist: bool,
 }
 
-/// Increases the font size in the editor buffer.
+/// Opens the settings editor at a specific path.
 #[derive(PartialEq, Clone, Debug, Deserialize, JsonSchema, Action)]
 #[action(namespace = zed)]
 #[serde(deny_unknown_fields)]
@@ -512,7 +512,7 @@ pub enum Spawn {
         #[serde(default)]
         reveal_target: Option<RevealTarget>,
     },
-    /// Spawns a task by the name given.
+    /// Spawns a task by the tag given.
     ByTag {
         task_tag: String,
         #[serde(default)]