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

Update documentation to use generators #36

Open
tsroten opened this issue Dec 24, 2017 · 4 comments
Open

Update documentation to use generators #36

tsroten opened this issue Dec 24, 2017 · 4 comments

Comments

@tsroten
Copy link
Member

tsroten commented Dec 24, 2017

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.

@aashraybhandar1
Copy link

Can I be assigned this issue

@amjith
Copy link
Member

amjith commented Apr 7, 2018

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

@aashraybhandar1
Copy link

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

@meeuw
Copy link
Collaborator

meeuw commented Apr 7, 2018

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(...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants