-
-
Notifications
You must be signed in to change notification settings - Fork 897
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
Improve hyprctl help pages #5385
Conversation
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.
The []
everywhere should be replaced with <>
where required, and []
where optional, just like most other help texts. This will also make the (opt)
redundant, thus freeing some visual space.
Yeah I agree that |
Sure, that sounds good. |
Done. Changed brackets. |
Love the update, thanks for doing this. |
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.
LGTM, thanks for the contribution!
Describe your PR, what does it fix/add?
References #4300
I hope I didn't miss anything. There's a lot of stuff hyprctl is capable of and some of the stuff isn't documented so I had to check for it in the code. Few descriptions are copy-pasted from the wiki.
As all help pages these are limited to 80 columns.
Is there anything you want to mention? (unchecked code, possible bugs, found problems, breaking compatibility, etc.)
Some commands have several arguments which with their description didn't fit into the help page somewhat nicely so I replaced them with three dots. You can use
hyprctl [command] --help
to print additional help for the command. I'm not sure if it's the best solution but it was the most optimal I came up with.Is it ready for merging, or does it need work?
Ready for merging