Skip to content
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

Merged
merged 3 commits into from
Apr 3, 2024
Merged

Improve hyprctl help pages #5385

merged 3 commits into from
Apr 3, 2024

Conversation

Micovec
Copy link
Contributor

@Micovec Micovec commented Apr 2, 2024

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

@vaxerski vaxerski requested a review from fufexan April 2, 2024 16:10
Copy link
Member

@fufexan fufexan left a 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.

@Micovec
Copy link
Contributor Author

Micovec commented Apr 2, 2024

Yeah I agree that [] should be for optional and <> for required. I tried to keep the original brackets to keep consistency. Should I keep arguments that can be repeated <> with three dots at the end? For example: hyprctl seterror <color> <message...>. Message doesn't necessarily need to be just one bash argument it can be multiple of them.

@fufexan
Copy link
Member

fufexan commented Apr 2, 2024

Sure, that sounds good.

@Micovec
Copy link
Contributor Author

Micovec commented Apr 2, 2024

Done. Changed brackets.

@khaneliman
Copy link

Love the update, thanks for doing this.

@Micovec Micovec requested a review from fufexan April 2, 2024 22:15
Copy link
Member

@fufexan fufexan left a 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!

@fufexan fufexan merged commit 949eb42 into hyprwm:main Apr 3, 2024
9 checks passed
lisuke pushed a commit to lisuke/Hyprland that referenced this pull request Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants