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

Change text references from "arguments" to "subcommands" #3360

Merged
merged 1 commit into from
Oct 9, 2023

Conversation

toadkarter
Copy link
Contributor

Fixes #3226

CHANGES
This PR changes text references in the --help command screen from "arguments" to "subcommands". The change is propagated to variable names in the code to avoid confusion where appropriate.

There are also some changes in the subcommand description text to match the man page more closely.

TESTING CRITERIA

  1. Open the help screen with the command flameshot --help.
  2. Notice that instead of references to "arguments", there are now references to "subcommands".
  3. Notice that descriptions for "full" and "screen" subcommands have been updated to cover scenarios relating to multiple monitors.

If you would like me to make any changes please don't hesitate to let me know.

@mmahmoudian
Copy link
Member

Thanks, at first I thought this is easy for me to review, but because the variable names are also changed, I cannot approve this myself. Lets let @veracioux review this PR

@toadkarter
Copy link
Contributor Author

Thanks, at first I thought this is easy for me to review, but because the variable names are also changed, I cannot approve this myself. Lets let @veracioux review this PR

No problem! I had initially intended just changing the text but then thought it might be confusing for anyone working on the code in the future if the variables were still called by the old name. I have no issues changing the names back to their originals though if needs be!

@toadkarter
Copy link
Contributor Author

Hmm, is that appimage failure something on my end?

@veracioux veracioux merged commit a8a3fd9 into flameshot-org:master Oct 9, 2023
21 of 22 checks passed
@toadkarter toadkarter deleted the improved-help-message branch October 9, 2023 20:15
@mmahmoudian
Copy link
Member

@toadkarter

Hmm, is that appimage failure something on my end?

No, that is a CI from our side that is failing to work and we have not yet managed to find time to figure out the issue. Don't worry about it.

Thanks for the PR and all the efforts 😃

@mmahmoudian mmahmoudian added this to the v13 milestone Oct 9, 2023
panpuchkov pushed a commit to namecheap/flameshot that referenced this pull request Dec 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve help message
3 participants