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.

Sign up for GitHub

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

Jump to bottom

updated/standardize command descriptions #313

Merged
merged 9 commits into from
Sep 20, 2024
Merged

updated/standardize command descriptions #313

merged 9 commits into from
Sep 20, 2024

Conversation

zackbradys
Copy link
Member

@zackbradys zackbradys commented Aug 27, 2024 •
edited
Loading

Please check below, if the PR fulfills these requirements:

  • Commit(s) and code follow the repositories guidelines.
  • Test(s) have been added or updated to support these change(s).
  • Doc(s) have been added or updated to support these change(s).

Associated Links:

Types of Changes:

  • Feature

Proposed Changes:

  • Changes: Updated, formatted, and standardized all command descriptions and examples for all commands/flags
  • Background: Over time we have had different descriptions and examples for each command and flag within hauler and it would be beneficial to have a standardized format and reference for each of them.

Verification/Testing of Changes:

  • View the PR Tests Workflow
    Clone the PR and run make build:

Additional Context:

  • N/A

@zackbradys zackbradys marked this pull request as ready for review September 1, 2024 03:05
@zackbradys zackbradys self-assigned this Sep 1, 2024
@zackbradys zackbradys added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 1, 2024
@zackbradys zackbradys added this to the Hauler v1.1.0 milestone Sep 1, 2024
@zackbradys zackbradys requested a review from a team September 1, 2024 03:06
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
dweomer
dweomer reviewed Sep 3, 2024
View reviewed changes
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
@zackbradys zackbradys requested review from dweomer and a team September 13, 2024 12:54
amartin120
amartin120 previously approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@amartin120 amartin120 left a comment

Choose a reason for hiding this comment

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

LGTM

atoy3731
atoy3731 reviewed Sep 20, 2024
View reviewed changes
cmd/hauler/cli/completion.go Outdated Show resolved Hide resolved
cmd/hauler/cli/completion.go Outdated Show resolved Hide resolved
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
cmd/hauler/cli/store.go Outdated Show resolved Hide resolved
atoy3731
atoy3731 approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@atoy3731 atoy3731 left a comment

Choose a reason for hiding this comment

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

LGTM.

@zackbradys zackbradys merged commit 407ed94 into hauler-dev:main Sep 20, 2024
2 checks passed
@zackbradys zackbradys deleted the hauler-command-descriptions branch September 20, 2024 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atoy3731 atoy3731 atoy3731 approved these changes

@amartin120 amartin120 amartin120 left review comments

@dweomer dweomer Awaiting requested review from dweomer

Assignees

@zackbradys zackbradys

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Hauler
Status: Resolved
Milestone
Hauler v1.1.0
Development

Successfully merging this pull request may close these issues.
4 participants
@zackbradys @dweomer @atoy3731 @amartin120