Skip to content

docs(bigquery): improve Client and ClientBuilder docs - #6201

Open
alvarowolfx wants to merge 5 commits into
googleapis:mainfrom
alvarowolfx:docs-bq-client
Open

docs(bigquery): improve Client and ClientBuilder docs#6201
alvarowolfx wants to merge 5 commits into
googleapis:mainfrom
alvarowolfx:docs-bq-client

Conversation

@alvarowolfx

Copy link
Copy Markdown
Contributor

Towards #5844

@product-auto-label product-auto-label Bot added the api: bigquery Issues related to the BigQuery API. label Jul 28, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request significantly improves the documentation for the BigQuery client and ClientBuilder by adding detailed usage guides, architecture explanations, and runnable doctest examples. Feedback was provided to add a hidden import for futures::StreamExt in the BigQuery example doctest to ensure it compiles successfully.

Comment thread src/bigquery/src/client.rs
@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.06%. Comparing base (210fed0) to head (65bdca7).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6201      +/-   ##
==========================================
- Coverage   96.06%   96.06%   -0.01%     
==========================================
  Files         268      268              
  Lines       67175    67175              
==========================================
- Hits        64534    64530       -4     
- Misses       2641     2645       +4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alvarowolfx
alvarowolfx marked this pull request as ready for review July 29, 2026 13:59
@alvarowolfx
alvarowolfx requested a review from a team as a code owner July 29, 2026 13:59
@alvarowolfx

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request adds comprehensive documentation and usage examples (doctests) to the BigQuery client and ClientBuilder structs. The feedback highlights that the newly added doctests using .next().await on streams will fail to compile because the futures::StreamExt trait is not brought into scope in the hidden setup lines.

Comment thread src/bigquery/src/client.rs
Comment thread src/bigquery/src/client.rs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigquery Issues related to the BigQuery API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant