-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Making the 'set-option' command help more descriptive. #2365
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could add a \n
in between there to format it as two lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@archseer how does this look?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! 🎉
The syntax for the new
set-option
command is not obvious, and I had to check the code to see what it was (code comment is what is included in this PR).