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

CLI Documentation update / CLI small bug fixes and format updates #726

Merged
merged 8 commits into from
Aug 1, 2024

Conversation

evrose54
Copy link
Contributor

@evrose54 evrose54 commented Jul 31, 2024

Reviewer Checklist

  • Required existing tests pass (ie full_test.sh, others as appropriate)
  • Required unit tests modified for updated functionality
  • NO REQUIRED integration tests (explain why not required)
  • Required documentation added for new/modified functionality
  • Required release notes added for new/modified functionality
  • NO REQUIRED updates to other repos (explain why not required)

Related Issues

N/A

Testing Instructions

Run pytest -v /tests/unit_tests/commandline/

Summary

Bug Fixes / Formatting Updates:

This PR fixed small bugs and formatting inconsistencies with the CLI. Specifically,
this PR addressed the format of the output of 'geoips describe' commands, to make
the keys in the yaml output all be in title format rather than (some_val:) vs.
(Some Val:). In this PR we were working on getting CLI documentation up to date,
and discovered a bug with 'geoips list packages' where the '--columns' flag was not
actually working. This was a simple fix and that functionality is now working as
expected. Unit tests have been updated to address these changes.

  geoips/commandline/commandline_interface.py
  geoips/commandline/geoips_command.py
  geoips/commandline/geoips_describe.py
  geoips/commandline/geoips_list.py
  tests/unit_tests/commandline/test_geoips_describe_interface.py
  tests/unit_tests/commandline/test_geoips_plugin.py
  tests/unit_tests/commandline/test_geoips_list_packages.py

CLI Documentation Updates:

This PR updated the CLI documentation to reflect the current state of the CLI code.
Largely, this PR went through the documentation of the CLI commands and made sure
that what was documented matched what would actually happen when that command was
ran. There was a duplicate entry in the documentation that was removed as well.
modified:

  docs/source/userguide/command_line.rst

@evrose54 evrose54 added bug Something isn't working refactor Code refactoring updates cli Command line interface tasks 2024-workshop labels Jul 31, 2024
Copy link
Contributor

@mindyls mindyls 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

@mindyls mindyls merged commit dbaa075 into main Aug 1, 2024
@mindyls mindyls deleted the CLI-documentation-update-for-workshop branch August 1, 2024 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024-workshop bug Something isn't working cli Command line interface tasks refactor Code refactoring updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants