Making the 'set-option' command help more descriptive. #2365
Conversation
helix-term/src/commands/typed.rs
Outdated
| @@ -1508,7 +1508,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. For example to disable smart case search, use `:set search.smart-case false`.", | |||
There was a problem hiding this comment.
Could add a \n in between there to format it as two lines?
There was a problem hiding this comment.
Ah, the generated docs table doesn't seem to support new lines. I think I can use a <br> instead.
There was a problem hiding this comment.
Ah, can you revert that and use \n? I'm fine with it being a single line in the HTML table, I just wanted it to display as two rows in the help popup in command mode
There was a problem hiding this comment.
Happy to, but it breaks the table rather than being one line--I'll add a screenshot shortly to show the issue.
There was a problem hiding this comment.
This new help message is 18 words, 104 characters. The messages for debug-remote, primary-clipboard-yank-join, clipboard-yank-join, and write! are all longer, fwiw.
There was a problem hiding this comment.
But it does look better in the pop-up as two lines:
vs
There was a problem hiding this comment.
Maybe this is something we can fix in the cargo xtask docgen that generates the docs? We could have it turn newlines into <br>s.
There was a problem hiding this comment.
Pushing a small patch to do this as suggested. Generates correct docs and correct in-app help:
There was a problem hiding this comment.
@archseer how does this look?
The syntax for the new
set-optioncommand is not obvious, and I had to check the code to see what it was (code comment is what is included in this PR).