PubSub: Document batch settings, make synth operations idempotent #8448
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 PR makes sure that
BatchSettings
settings are properly documented in the generated documentation. It also fixes multiple repeated blocks for addingFlowControl
docstrings (supersedes #8447).How to test
Steps to perform:
(from inside the
pubsub/
directory)BatchSettings
:Actual result (before the fix):
FlowControl
docstrings is added after every synthtool run, growing the file indefinitely.BatchSettings
attributes only have uninformative generic descriptions.Expected result (after the fix):
types.py
by the synthtool.BatchSettings
type and its attributes have nice descriptions (as opposed to the current docs).