docs(gax): include streaming APIs#1487
Merged
dbolduc merged 1 commit intogoogleapis:mainfrom Mar 13, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1487 +/- ##
=======================================
Coverage 95.95% 95.95%
=======================================
Files 38 38
Lines 1531 1531
=======================================
Hits 1469 1469
Misses 62 62 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
coryan
approved these changes
Mar 13, 2025
|
|
||
| [package.metadata.docs.rs] | ||
| # We want to generate documentation for streaming APIs, gated by this feature. | ||
| # We do not want to generate documentation for `unstable-sdk-client`, which |
Collaborator
There was a problem hiding this comment.
Maybe it should be called _unstable-sdk-client...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of the work for #1468
Paginator will (hopefully soon) pick up a
fn to_stream()which is gated by theunstable-streamfeature. We want this to appear in our docs.While client crates currently have an
unstable-streamfeature which is gating theirstream()methods, and preventing the methods from appearing in our docs, we plan to change the method topaginator()and make it always available. (Hence there are no changes to client crates).See: https://docs.rs/about/metadata
Aside: Remind me where I can look at the generated documentation to make sure this change actually works...