Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

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

Merged
plamut merged 2 commits into
googleapis:masterfrom
shollyman:docs-rowiterator
Jun 11, 2020
Merged

doc: update wording in rowiterator docstrings to reduce confusion#127
plamut merged 2 commits into
googleapis:masterfrom
shollyman:docs-rowiterator

Conversation

@shollyman

Copy link
Copy Markdown
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
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 9, 2020
@shollyman

Copy link
Copy Markdown
ContributorAuthor

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 plamutJune 9, 2020 22:41

@plamutplamut left a comment

Copy link
Copy Markdown
Contributor

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.

@plamutplamut 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
@plamutplamut added the type: docs Improvement to the documentation for an API. label Jun 11, 2020
@plamut
plamut merged commit 445ae08 into googleapis:masterJun 11, 2020
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla: yesThis human has signed the Contributor License Agreement.type: docsImprovement 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

@shollyman@plamut@googlebot