Shorten typed command descriptions

Author: sudormrfbin

book/src/generated/typable-cmd.md

@@ -1,18 +1,18 @@
 | Name | Description |
 | --- | --- |
 | `:quit`, `:q` | Close the current view. |
-| `:quit!`, `:q!` | Close the current view forcefully (ignoring unsaved changes). |
+| `:quit!`, `:q!` | Force close the current view, ignoring unsaved changes. |
 | `:open`, `:o` | Open a file from disk into the current view. |
 | `:buffer-close`, `:bc`, `:bclose` | Close the current buffer. |
-| `:buffer-close!`, `:bc!`, `:bclose!` | Close the current buffer forcefully (ignoring unsaved changes). |
+| `:buffer-close!`, `:bc!`, `:bclose!` | Close the current buffer forcefully, ignoring unsaved changes. |
 | `:buffer-close-others`, `:bco`, `:bcloseother` | Close all buffers but the currently focused one. |
-| `:buffer-close-others!`, `:bco!`, `:bcloseother!` | Close all buffers but the currently focused one. |
-| `:buffer-close-all`, `:bca`, `:bcloseall` | Close all buffers, without quitting. |
-| `:buffer-close-all!`, `:bca!`, `:bcloseall!` | Close all buffers forcefully (ignoring unsaved changes), without quitting. |
-| `:buffer-next`, `:bn`, `:bnext` | Go to next buffer. |
-| `:buffer-previous`, `:bp`, `:bprev` | Go to previous buffer. |
+| `:buffer-close-others!`, `:bco!`, `:bcloseother!` | Force close all buffers but the currently focused one. |
+| `:buffer-close-all`, `:bca`, `:bcloseall` | Close all buffers without quitting. |
+| `:buffer-close-all!`, `:bca!`, `:bcloseall!` | Force close all buffers ignoring unsaved changes without quitting. |
+| `:buffer-next`, `:bn`, `:bnext` | Goto next buffer. |
+| `:buffer-previous`, `:bp`, `:bprev` | Goto previous buffer. |
 | `:write`, `:w` | Write changes to disk. Accepts an optional path (:write some/path.txt) |
-| `:write!`, `:w!` | Write changes to disk forcefully (creating necessary subdirectories). Accepts an optional path (:write some/path.txt) |
+| `:write!`, `:w!` | Force write changes to disk creating necessary subdirectories. Accepts an optional path (:write some/path.txt) |
 | `:new`, `:n` | Create a new scratch buffer. |
 | `:format`, `:fmt` | Format the file using the LSP formatter. |
 | `:indent-style` | Set the indentation style for editing. ('t' for tabs or 1-8 for number of spaces.) |
@@ -25,9 +25,9 @@
 | `:write-quit-all`, `:wqa`, `:xa` | Write changes from all buffers to disk and close all views. |
 | `:write-quit-all!`, `:wqa!`, `:xa!` | Write changes from all buffers to disk and close all views forcefully (ignoring unsaved changes). |
 | `:quit-all`, `:qa` | Close all views. |
-| `:quit-all!`, `:qa!` | Close all views forcefully (ignoring unsaved changes). |
+| `:quit-all!`, `:qa!` | Force close all views ignoring unsaved changes. |
 | `:cquit`, `:cq` | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
-| `:cquit!`, `:cq!` | Quit with exit code (default 1) forcefully (ignoring unsaved changes). Accepts an optional integer exit code (:cq! 2). |
+| `:cquit!`, `:cq!` | Force quit with exit code (default 1) ignoring unsaved changes. Accepts an optional integer exit code (:cq! 2). |
 | `:theme` | Change the editor theme. |
 | `:clipboard-yank` | Yank main selection into system clipboard. |
 | `:clipboard-yank-join` | Yank joined selections into system clipboard. A separator can be provided as first argument. Default value is newline. |
@@ -42,7 +42,7 @@
 | `:show-clipboard-provider` | Show clipboard provider name in status bar. |
 | `:change-current-directory`, `:cd` | Change the current working directory. |
 | `:show-directory`, `:pwd` | Show the current working directory. |
-| `:encoding` | Set encoding based on `https://encoding.spec.whatwg.org` |
+| `:encoding` | Set encoding. Based on `https://encoding.spec.whatwg.org`. |
 | `:reload` | Discard changes and reload from the source file. |
 | `:tree-sitter-scopes` | Display tree sitter scopes, primarily for theming and development. |
 | `:debug-start`, `:dbg` | Start a debug session from a given template with given parameters. |
@@ -53,16 +53,16 @@
 | `:hsplit`, `:hs`, `:sp` | Open the file in a horizontal split. |
 | `:hsplit-new`, `:hnew` | Open a scratch buffer in a horizontal split. |
 | `:tutor` | Open the tutorial. |
-| `:goto`, `:g` | Go to line number. |
+| `:goto`, `:g` | Goto line number. |
 | `:set-language`, `:lang` | Set the language of current buffer. |
 | `:set-option`, `:set` | Set a config option at runtime.<br>For example to disable smart case search, use `:set search.smart-case false`. |
 | `:get-option`, `:get` | Get the current value of a config option. |
 | `:sort` | Sort ranges in selection. |
 | `:rsort` | Sort ranges in selection in reverse order. |
 | `:reflow` | Hard-wrap the current selection of lines to a given width. |
 | `:tree-sitter-subtree`, `:ts-subtree` | Display tree sitter subtree under cursor, primarily for debugging queries. |
-| `:config-reload` | Refreshes helix's config. |
-| `:config-open` | Open the helix config.toml file. |
+| `:config-reload` | Refresh user config. |
+| `:config-open` | Open the user config.toml file. |
 | `:log-open` | Open the helix log file. |
 | `:insert-output` | Run shell command, inserting output after each selection. |
 | `:append-output` | Run shell command, appending output after each selection. |

helix-term/src/commands/typed.rs

@@ -1528,7 +1528,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "quit!",
             aliases: &["q!"],
-            doc: "Close the current view forcefully (ignoring unsaved changes).",
+            doc: "Force close the current view, ignoring unsaved changes.",
             fun: force_quit,
             completer: None,
         },
@@ -1549,7 +1549,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "buffer-close!",
             aliases: &["bc!", "bclose!"],
-            doc: "Close the current buffer forcefully (ignoring unsaved changes).",
+            doc: "Close the current buffer forcefully, ignoring unsaved changes.",
             fun: force_buffer_close,
             completer: Some(completers::buffer),
         },
@@ -1563,35 +1563,35 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "buffer-close-others!",
             aliases: &["bco!", "bcloseother!"],
-            doc: "Close all buffers but the currently focused one.",
+            doc: "Force close all buffers but the currently focused one.",
             fun: force_buffer_close_others,
             completer: None,
         },
         TypableCommand {
             name: "buffer-close-all",
             aliases: &["bca", "bcloseall"],
-            doc: "Close all buffers, without quitting.",
+            doc: "Close all buffers without quitting.",
             fun: buffer_close_all,
             completer: None,
         },
         TypableCommand {
             name: "buffer-close-all!",
             aliases: &["bca!", "bcloseall!"],
-            doc: "Close all buffers forcefully (ignoring unsaved changes), without quitting.",
+            doc: "Force close all buffers ignoring unsaved changes without quitting.",
             fun: force_buffer_close_all,
             completer: None,
         },
         TypableCommand {
             name: "buffer-next",
             aliases: &["bn", "bnext"],
-            doc: "Go to next buffer.",
+            doc: "Goto next buffer.",
             fun: buffer_next,
             completer: None,
         },
         TypableCommand {
             name: "buffer-previous",
             aliases: &["bp", "bprev"],
-            doc: "Go to previous buffer.",
+            doc: "Goto previous buffer.",
             fun: buffer_previous,
             completer: None,
         },
@@ -1605,7 +1605,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "write!",
             aliases: &["w!"],
-            doc: "Write changes to disk forcefully (creating necessary subdirectories). Accepts an optional path (:write some/path.txt)",
+            doc: "Force write changes to disk creating necessary subdirectories. Accepts an optional path (:write some/path.txt)",
             fun: force_write,
             completer: Some(completers::filename),
         },
@@ -1699,7 +1699,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "quit-all!",
             aliases: &["qa!"],
-            doc: "Close all views forcefully (ignoring unsaved changes).",
+            doc: "Force close all views ignoring unsaved changes.",
             fun: force_quit_all,
             completer: None,
         },
@@ -1713,7 +1713,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "cquit!",
             aliases: &["cq!"],
-            doc: "Quit with exit code (default 1) forcefully (ignoring unsaved changes). Accepts an optional integer exit code (:cq! 2).",
+            doc: "Force quit with exit code (default 1) ignoring unsaved changes. Accepts an optional integer exit code (:cq! 2).",
             fun: force_cquit,
             completer: None,
         },
@@ -1818,7 +1818,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "encoding",
             aliases: &[],
-            doc: "Set encoding based on `https://encoding.spec.whatwg.org`",
+            doc: "Set encoding. Based on `https://encoding.spec.whatwg.org`.",
             fun: set_encoding,
             completer: None,
         },
@@ -1895,7 +1895,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "goto",
             aliases: &["g"],
-            doc: "Go to line number.",
+            doc: "Goto line number.",
             fun: goto_line_number,
             completer: None,
         },
@@ -1951,14 +1951,14 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[
         TypableCommand {
             name: "config-reload",
             aliases: &[],
-            doc: "Refreshes helix's config.",
+            doc: "Refresh user config.",
             fun: refresh_config,
             completer: None,
         },
         TypableCommand {
             name: "config-open",
             aliases: &[],
-            doc: "Open the helix config.toml file.",
+            doc: "Open the user config.toml file.",
             fun: open_config,
             completer: None,
         },