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

Added some documentation text to sync command #240

Merged
merged 1 commit into from
Jun 10, 2024

Conversation

pat-earl
Copy link
Contributor

@pat-earl pat-earl commented May 2, 2024

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:

  • N/A

Types of Changes:

  • Added some documentation to the sync subcommand usage text. Clarified it's usage for local Hauler manifests.
  • Included an example of using the files flag similar to products flag.

Proposed Changes:

  • Provide clarifying language to the help text for the sync subcommand. I missed the --files flag my first time through the online Documentation and wanted to see it in the help text for the command.

Verification/Testing of Changes:

  • Run hauler store sync --help to see the changes

Additional Context:

  • This is a small change to the usage text of a CLI subcommand.

@zackbradys
Copy link
Member

zackbradys commented May 18, 2024

Hey @pat-earl, thanks for the contribution and it does make sense to have more clarity and an example in the subcommand, but I believe we will be implementing remote files to hauler store sync, so this may be unnecessary. we'll keep this open for now until I can get confirmation on it!

@zackbradys zackbradys added documentation Improvements or additions to documentation size/S Denotes an issue/PR requiring a relatively small amount of work labels May 18, 2024
@zackbradys
Copy link
Member

CC: @amartin120

@zackbradys zackbradys self-assigned this May 28, 2024
@zackbradys zackbradys added the enhancement New feature or request label May 28, 2024
@zackbradys zackbradys merged commit f477444 into hauler-dev:main Jun 10, 2024
@pat-earl pat-earl deleted the doc_updates branch June 20, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request size/S Denotes an issue/PR requiring a relatively small amount of work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants