cli_helpers icon indicating copy to clipboard operation
cli_helpers copied to clipboard

Update documentation to use generators

Open tsroten opened this issue 8 years ago • 4 comments

The current documentation assumes that the output format is a list, but CLI Helpers now returns generators. We should update the quick start and the API documentation.

tsroten avatar Dec 24 '17 17:12 tsroten

Can I be assigned this issue

aashraybhandar1 avatar Apr 07 '18 06:04 aashraybhandar1

@aashraybhandar1 Go forth and send a PR. We won't start working on it.

Github only allows people with commit access to the repo to have assignments. So I can't officially assign it to you but I can assure you that we're not actively working on it.

amjith avatar Apr 07 '18 06:04 amjith

The result of the various adapters is a generator so the change should be made for the format_output option ? @tsroten @amjith

aashraybhandar1 avatar Apr 07 '18 12:04 aashraybhandar1

I think a good start would be to verify the documentation in: https://github.com/dbcli/cli_helpers/blob/master/docs/source/quickstart.rst

The examples return list_iterator objects instead of lists, I think this needs to be updated to "\n".join(...)

meeuw avatar Apr 07 '18 18:04 meeuw