diff options
| author | Ben Lee-Cohen | 2022-05-04 02:17:08 +0000 |
|---|---|---|
| committer | GitHub | 2022-05-04 02:17:08 +0000 |
| commit | 09a17e4fa3d0aa67e399c02c484a768d85acaac6 (patch) | |
| tree | 60f097b309ee1897f150ccf321239b4f71b841b7 | |
| parent | f59b3b91c86d8f92ce72a4bb873bbb6aaaa4d2a9 (diff) | |
Making the 'set-option' command help more descriptive. (#2365)
* Making the 'set-option' command help more descriptive.
* Adding the generated docs
* Making the message multi-line
* Replace newline with break in generated docs
| -rw-r--r-- | book/src/generated/typable-cmd.md | 2 | ||||
| -rw-r--r-- | helix-term/src/commands/typed.rs | 2 | ||||
| -rw-r--r-- | xtask/src/main.rs | 4 |
3 files changed, 5 insertions, 3 deletions
diff --git a/book/src/generated/typable-cmd.md b/book/src/generated/typable-cmd.md index 426598e3..17d10c99 100644 --- a/book/src/generated/typable-cmd.md +++ b/book/src/generated/typable-cmd.md @@ -55,7 +55,7 @@ | `:tutor` | Open the tutorial. | | `:goto`, `:g` | Go to line number. | | `:set-language`, `:lang` | Set the language of current buffer. | -| `:set-option`, `:set` | Set a config option at runtime. | +| `: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. | diff --git a/helix-term/src/commands/typed.rs b/helix-term/src/commands/typed.rs index 68aa7703..68b64bb8 100644 --- a/helix-term/src/commands/typed.rs +++ b/helix-term/src/commands/typed.rs @@ -1594,7 +1594,7 @@ pub const TYPABLE_COMMAND_LIST: &[TypableCommand] = &[ TypableCommand { name: "set-option", aliases: &["set"], - doc: "Set a config option at runtime.", + doc: "Set a config option at runtime.\nFor example to disable smart case search, use `:set search.smart-case false`.", fun: set_option, completer: Some(completers::setting), }, diff --git a/xtask/src/main.rs b/xtask/src/main.rs index ad120f4f..a4c69d70 100644 --- a/xtask/src/main.rs +++ b/xtask/src/main.rs @@ -106,7 +106,9 @@ pub mod md_gen { .collect::<Vec<_>>() .join(", "); - md.push_str(&md_table_row(&[names.to_owned(), cmd.doc.to_owned()])); + let doc = cmd.doc.replace("\n", "<br>"); + + md.push_str(&md_table_row(&[names.to_owned(), doc.to_owned()])); } Ok(md) |