docs(pubsub): improve flush documentation#4930
Merged
suzmue merged 2 commits intogoogleapis:mainfrom Mar 9, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4930 +/- ##
=======================================
Coverage 93.94% 93.94%
=======================================
Files 221 221
Lines 8538 8538
=======================================
Hits 8021 8021
Misses 517 517 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
coryan
approved these changes
Mar 8, 2026
Comment on lines
+106
to
+107
| /// messages buffered at the time of the call have reached a terminal state | ||
| /// (success or permanent failure). |
Collaborator
There was a problem hiding this comment.
Optional:
Suggested change
| /// messages buffered at the time of the call have reached a terminal state | |
| /// (success or permanent failure). | |
| /// messages buffered at the time of the call have been successfully delivered, | |
| /// the retry policy determines the error is permanent, or the retry policy has | |
| /// been exhausted. |
Collaborator
Author
There was a problem hiding this comment.
I skipped this suggestion for now.
src/pubsub/src/publisher/client.rs
Outdated
Comment on lines
+111
to
+115
| /// * **Individual Confirmation:** For most use cases, it is better to `.await` | ||
| /// the [`PublishFuture`][crate::publisher::PublishFuture] returned by | ||
| /// [`publish`][Self::publish] to retrieve message IDs and handle specific errors. | ||
| /// * **Collective Flush:** Use `flush()` for collective confirmation or as a | ||
| /// convenience during application shutdown to ensure all outstanding data is sent. |
Collaborator
There was a problem hiding this comment.
I am not sure what "collective flush" or "collective confirmation" are 1.
Suggested change
| /// * **Individual Confirmation:** For most use cases, it is better to `.await` | |
| /// the [`PublishFuture`][crate::publisher::PublishFuture] returned by | |
| /// [`publish`][Self::publish] to retrieve message IDs and handle specific errors. | |
| /// * **Collective Flush:** Use `flush()` for collective confirmation or as a | |
| /// convenience during application shutdown to ensure all outstanding data is sent. | |
| /// * For most use cases, we recommend you `.await` | |
| /// the [`PublishFuture`][crate::publisher::PublishFuture] returned by | |
| /// [`publish`][Self::publish] to retrieve message IDs and handle specific errors. | |
| /// * Use `flush()` as a convenience during application shutdown to ensure all | |
| /// outstanding data is sent. |
Footnotes
-
Sounds like something the communist cadres would ask you to commit to, but maybe I have been reading too much 20th-century history. ↩
Member
There was a problem hiding this comment.
nit: maybe "to ensure the client attempts to send all outstanding data." ?
flush() can't tell you if the data was actually sent or not.
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
3 participants
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.
This rework of the documentation attempts to make the wording and the example more concise. It also now tries to guide users to await on the PublishFutures instead.