Code review comment for lp:~jaypipes/glance/glance-cli-tool

Revision history for this message
Jay Pipes (jaypipes) wrote :

> Looks great. I thought I'd pass along some things I like in novatools:
>
> 1. the use of PrettyTable to make the output look nice. It's a small, flexible
> package and would remove the need for the '-' * 16 stuff.
> http://code.google.com/p/prettytable/

Hmm, I'll check that out. Thanks for the heads up!

> 2. Novatools goes through great pain to enforce Don't Repeat Yourself (DRY).
> All of the command line options are decorated so that they produce the --help
> output and we don't have to run around to update 3-4 different files whenever
> a command signature changes. It would be great to see that in this client
> shell as well.

All --help documentation is generated from the relevant function's docstrings. Other than the actual RST docs, there's only a single place to change. Does Novatools have RST docs that are auto-generated from the decorators somehow? Is the --help output for Novatools only the function signature (because there's a lot more to the help output in bin/glance, including example usage...)?

-jay

« Back to merge proposal