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

docs: remove nextQuery docs & annotate arrays correctly #1559

Merged
merged 1 commit into from
Sep 6, 2016

Conversation

stephenplusplus
Copy link
Contributor

Was looking through the docs, and noticed we were inconsistent with documenting the callback.nextQuery param. I think it makes sense to remove it and show how that flow works in the @­example section. I also found various places where we weren't specifying a user would get an array of objects back, but only an object, i.e. {module:compute/vm} callback.vms instead of {module:compute/vm[]} callback.vms.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 2, 2016
@stephenplusplus stephenplusplus added docs and removed cla: yes This human has signed the Contributor License Agreement. labels Sep 2, 2016
@coveralls
Copy link

coveralls commented Sep 2, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling 43f2c42 on stephenplusplus:spp--nextquery-rm into bf9929e on GoogleCloudPlatform:master.

@callmehiphop
Copy link
Contributor

So why are we removing nextQuery everywhere? I can't help but think only documenting it in examples would be confusing to the user.

@stephenplusplus
Copy link
Contributor Author

Well, it started because we were inconsistent. It was in some APIs and not in others. Frankly, I removed it because the whole thing is pretty confusing. We support the nextQuery flow because there might be some users who find it important to manually paginate through results. But if we show documentation suggesting it's always there, I think that introduces confusion to the majority user who isn't thinking about pagination... they're just trying to get all the results in one method call, and no such nextQuery object will exist.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants