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

Correct usage strings #357

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Correct usage strings #357

merged 1 commit into from
Nov 1, 2024

Conversation

foodprocessor
Copy link
Contributor

Make usage strings use square brackets for optional arguments and angle brackets for required arguments.
Since Cobra already adds "[flags]" to the usage string automatically when a command has flags, change our usage strings to just describe our required arguments and let Cobra do the rest.

What type of Pull Request is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Describe your changes in brief

Correct usage strings

Checklist

  • Tested locally
  • Added new dependencies
  • Updated documentation
  • Added tests

Related Issues

  • Related Issue #
  • Closes #

@foodprocessor foodprocessor merged commit 27302db into main Nov 1, 2024
17 checks passed
@foodprocessor foodprocessor deleted the fix-usage-strings branch November 1, 2024 21:55
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.

2 participants