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

doc: update wording in rowiterator docstrings to reduce confusion #127

Merged
merged 2 commits into from Jun 11, 2020

Conversation

shollyman
Copy link
Contributor

Talking about partition filtration can be problematic, so refer
to Storage API capabilities more obliquely. Particularly, partition
filtration is possible via a query or a direct storage API read, so
don't use as severe of language when describing helper mechanisms such
as to_dataframe() on row iterators.

Fixes: googleapis/python-bigquery-storage#22

Goal: Talking about partition filtration can be problematic, so refer
to Storage API capabilities more obliquely.  Particularly, partition
filtration is possible via a query or a direct storage API read, so
don't use as severe of language when describing helper mechanisms such
as to_dataframe() on row iterators.

Fixes: googleapis/python-bigquery-storage#22
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 9, 2020
@shollyman
Copy link
Contributor Author

I anticipate this may cause minor conflicts with #55 so let's get that in, then we can followup with smaller doc changes like this and cleanup for the small anonymous result issues (I didn't excise those adjacent language blocks).

@shollyman shollyman requested a review from plamut June 9, 2020 22:41
Copy link
Contributor

@plamut plamut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few duplicated spaces, but that's OK, since they are rendered as a single space in HTML rendered, and just barely noticeable.

I agree with waiting until #55 gets merged first.

@plamut plamut added do not merge Indicates a pull request not ready for merge, due to either quality or timing. and removed do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Jun 10, 2020
@plamut plamut added the type: docs Improvement to the documentation for an API. label Jun 11, 2020
@plamut plamut merged commit 445ae08 into googleapis:master Jun 11, 2020
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. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Question] RowIterator documentation on bigquery storage api not entirely clear
3 participants