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

doc(hyprctl): enhance hyprctl help messages #3368

Closed
wants to merge 3 commits into from

Conversation

memchr
Copy link
Contributor

@memchr memchr commented Sep 19, 2023

Addtional Changes

  • removed unused variables in hyprctl main.cpp
  • prevent comparing integers of different signs

Copy link

@luxluth luxluth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Good but for me the dot at the end of a command (monitors:) is to much cluter. Consider just writing monitors

hyprctl --batch {<command 1> [args] ; <command 2> [args] ; ...}

LISTING COMMANDS:
monitors: List outputs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are the : everywhere?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They probably took the style of writing from their language.
For the same purpose that you use "->" for

getoption <option>: Get value of <option>
reload: Reload configurations

PLUGIN:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plugins makes more sense

plugin unload <path>: Unload plugin at <path>

THEMING:
hyprpaper <keywords> Issue hyprpaper keywords using IPC
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hyprpaper should not be in theming, maybe a separate category called "integrations"?

const std::string USAGE = R"#(usage: hyprctl [flags] [<command> [args]]
hyprctl --batch {<command 1> [args] ; <command 2> [args] ; ...}

LISTING COMMANDS:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

query commands fits better imo

Copy link

@BurningPho3nix BurningPho3nix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If Vaxry's proposed changes are implemented, I would approve

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.

None yet

4 participants