docs: Expose ReadChangeStreamFromSpanner in Beam Spanner documentation #36428
Conversation
The `ReadChangeStreamFromSpanner` class was not being picked up by the automatic Python documentation (pydoc) generation used for the Apache Beam website. This change explicitly adds the class to the relevant array in the Spanner connector's documentation configuration.
Summary of ChangesHello @flpablo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a documentation gap in the Apache Beam Spanner connector. It ensures that the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
|
assign set of reviewers |
|
Assigning reviewers: R: @tvalentyn for label python. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Please fix the docs error: |
|
the logs can be found in the details of the "PythonDocs" test suite that currently fails https://github.com/apache/beam/actions/runs/18380549271/job/52365635645?pr=36428 |
|
@tvalentyn Thanks for the observation. Fixed the formatting error: https://github.com/apache/beam/actions/runs/18420381156/job/52493179592?pr=36428 |
Please add a meaningful description for your change here
The
ReadChangeStreamFromSpannerclass was not being picked up by the automatic Python documentation (pydoc) generation used for the Apache Beam website (https://beam.apache.org/releases/pydoc/2.68.0/apache_beam.io.gcp.spanner.html)This change explicitly adds the class to the relevant array in the Spanner connector's documentation configuration.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.