docs: add example docs for @validate and @validate_async_generator
#422
Conversation
ahoblitz
force-pushed
the
doc/helper-utils
branch
from
98ac6cb to
2a9c509
Compare
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation, including examples, to the validate and validate_async_generator helper functions. While adding documentation is a valuable contribution, the provided examples, which are formatted as doctests, have several issues that would prevent them from running successfully. These include dependencies on undefined types, incomplete object initializations, calls to undefined methods, and incorrect formatting for exception testing. My review provides detailed feedback and corrected code suggestions to ensure the doctests are valid, self-contained, and robust. This will improve the quality and reliability of the documentation for future users.
|
/gemini review |
holtskinner
changed the title
@validate and @validate_async_generator
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation and examples for the validate and validate_async_generator utility helpers. The new docstrings significantly improve the developer experience by demonstrating usage patterns. My review includes suggestions to make the doctest examples more complete and robust by ensuring they are runnable and cover both success and failure scenarios, which will further enhance their utility.
🤖 I have created a release *beep* *boop* --- ## [0.3.5](v0.3.4...v0.3.5) (2025-09-08) ### Bug Fixes * Prevent client disconnect from stopping task execution ([#440](#440)) ([58b4c81](58b4c81)), closes [#296](#296) * **proto:** Adds metadata field to A2A DataPart proto ([#455](#455)) ([6d0ef59](6d0ef59)) ### Documentation * add example docs for `[@Validate](https://github.com/validate)` and `[@Validate](https://github.com/validate)_async_generator` ([#422](#422)) ([18289eb](18289eb)) * Restructure README ([9758f78](9758f78)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
2 participants
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.fix:which represents bug fixes, and correlates to a SemVer patch.feat:represents a new feature, and correlates to a SemVer minor.feat!:, orfix!:,refactor!:, etc., which represent a breaking change (indicated by the!) and will result in a SemVer major.bash scripts/format.shfrom the repository root to format)