With the addition of the GeoIPS CLI (see #444), we added a yaml file (geoips/geoips/commandline/ancillary_info/cmd_instructions.yaml) which contains help information for each geoips command. This is a nice format for retrieving help instructions, however the file is a bit verbose and some sections are very similar to other sections. We should consider refactoring this file to reduce duplication of instructions, or consider the use of anchors / aliases to reduce the repetition of instructions.
Background and Motivation
This issue was inspired via the comments left here, on the CLI PR #444.
Alternative Solutions
Leave the instructions as is.
Code to demonstrate issue
See geoips/geoips/commandline/ancillary_info/cmd_instructions.yaml on PR #444 for more information.
Requested Update
Description
With the addition of the GeoIPS CLI (see #444), we added a yaml file (
geoips/geoips/commandline/ancillary_info/cmd_instructions.yaml) which contains help information for each geoips command. This is a nice format for retrieving help instructions, however the file is a bit verbose and some sections are very similar to other sections. We should consider refactoring this file to reduce duplication of instructions, or consider the use ofanchors / aliasesto reduce the repetition of instructions.Background and Motivation
This issue was inspired via the comments left here, on the CLI PR #444.
Alternative Solutions
Leave the instructions as is.
Code to demonstrate issue
geoips/geoips/commandline/ancillary_info/cmd_instructions.yamlon PR #444 for more information.