Improve PostingsForMatcher doc string

Signed-off-by: Arve Knudsen <[email protected]>
grafana · Mar 19, 2024 · 013a4cb · 013a4cb
1 parent 02d022d
commit 013a4cb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/tsdb/block.go b/tsdb/block.go
@@ -74,8 +74,8 @@ type IndexReader interface {
 	// LabelValues returns possible label values which may not be sorted.
 	LabelValues(ctx context.Context, name string, matchers ...*labels.Matcher) ([]string, error)
 
-	// PostingsForMatcher returns a sorted iterator over postings matching the provided label matcher.
-	// This method will not return postings for missing labels.
+	// PostingsForMatcher returns a sorted iterator over postings having a label matching the provided label matcher.
+	// If no postings are found having a label with the correct name and matching value, an empty iterator is returned.
 	PostingsForMatcher(ctx context.Context, m *labels.Matcher) index.Postings
 
 	// PostingsForMatchers assembles a single postings iterator based on the given matchers.

diff --git a/tsdb/postings_for_matchers_cache.go b/tsdb/postings_for_matchers_cache.go
@@ -34,8 +34,8 @@ type IndexPostingsReader interface {
 	// LabelValues returns possible label values which may not be sorted.
 	LabelValues(ctx context.Context, name string, matchers ...*labels.Matcher) ([]string, error)
 
-	// PostingsForMatcher returns a sorted iterator over postings matching the provided label matcher.
-	// This method will not return postings for missing labels.
+	// PostingsForMatcher returns a sorted iterator over postings having a label matching the provided label matcher.
+	// If no postings are found having a label with the correct name and matching value, an empty iterator is returned.
 	PostingsForMatcher(ctx context.Context, m *labels.Matcher) index.Postings
 }