CLI Documentation update / CLI small bug fixes and format updates #726
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reviewer Checklist
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.
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: