Skip to content

docs(gax): include streaming APIs#1487

Merged
dbolduc merged 1 commit intogoogleapis:mainfrom
dbolduc:docs-gax-streams
Mar 13, 2025
Merged

docs(gax): include streaming APIs#1487
dbolduc merged 1 commit intogoogleapis:mainfrom
dbolduc:docs-gax-streams

Conversation

@dbolduc
Copy link
Member

@dbolduc dbolduc commented Mar 13, 2025

Part of the work for #1468

Paginator will (hopefully soon) pick up a fn to_stream() which is gated by the unstable-stream feature. We want this to appear in our docs.

While client crates currently have an unstable-stream feature which is gating their stream() methods, and preventing the methods from appearing in our docs, we plan to change the method to paginator() 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...

@codecov
Copy link

codecov bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.95%. Comparing base (e5d7b72) to head (d6c69db).
Report is 2 commits behind head on main.

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.
📢 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.

@dbolduc dbolduc marked this pull request as ready for review March 13, 2025 16:55

[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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it should be called _unstable-sdk-client...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack, not for this PR.

@dbolduc dbolduc merged commit c5d110e into googleapis:main Mar 13, 2025
20 checks passed
@dbolduc dbolduc deleted the docs-gax-streams branch March 13, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants