mirror/ helix
1
0
Fork 0
mirror of https://github.com/helix-editor/helix synced 2024-05-29 06:46:03 +02:00
Code Issues

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
This commit is contained in:
Ben Lee-Cohen 2022-05-03 22:17:08 -04:00 committed by GitHub
parent f59b3b91c8
commit 09a17e4fa3
Signed by: GitHub
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
book/src/generated/typable-cmd.md
View File

@ -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. |

2
helix-term/src/commands/typed.rs
View File

@ -1594,7 +1594,7 @@ fn run_shell_command(
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),
},

4
xtask/src/main.rs
View File

@ -106,7 +106,9 @@ pub fn typable_commands() -> Result<String, DynError> {
.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)