docs: follow-up fixes for collect() generator examples (#1169) - #1172
Merged
csmarchbanks merged 2 commits intoMay 4, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
…text Add a note to the collect() protocol section explaining that yield is idiomatic (generator iterates lazily, no state between scrapes) and a preamble to the API Reference section clarifying that code snippets belong inside a collect() method. Follows up on review feedback in prometheus#1169. Signed-off-by: k1chik <kkukdia@gmail.com>
The single block with two yield statements looked like one collect() yielding both patterns. Split into labelled prose + code pairs to make clear they are alternatives, not sequential yields. Signed-off-by: k1chik <kkukdia@gmail.com>
csmarchbanks
approved these changes
May 4, 2026
csmarchbanks
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Thanks!
Sorry, something went wrong.
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.
@csmarchbanks
Three issues raised in review of #1169 by @calestyo:
The API Reference code examples used bare yield statements without
any surrounding def collect(self): context, making it unclear what
they belonged to. Added a preamble to the API Reference section
pointing back to the top-level example.
The InfoMetricFamily example had two yield statements in a single
block, which looked like one collect() yielding both patterns rather
than two alternatives. Split into separate labelled blocks.
The collect() protocol section gave no explanation for why generators
are used. Added a note explaining that yield is idiomatic (lazy
iteration, no intermediate list) and that each scrape gets a fresh call
with no state carried over.