Document non-obvious function behaviour (grafana#1504)

Signed-off-by: Goutham Veeramachaneni <[email protected]>
cyriltovena · Jul 10, 2019 · 9027304 · 9027304
1 parent 7565090
commit 9027304
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/chunk_store_utils.go b/chunk_store_utils.go
@@ -150,7 +150,8 @@ func (c *Fetcher) worker() {
 	}
 }
 
-// FetchChunks fetchers a set of chunks from cache and store.
+// FetchChunks fetches a set of chunks from cache and store. Note that the keys passed in must be
+// lexicographically sorted, while the returned chunks are not in the same order as the passed in chunks.
 func (c *Fetcher) FetchChunks(ctx context.Context, chunks []Chunk, keys []string) ([]Chunk, error) {
 	log, ctx := spanlogger.New(ctx, "ChunkStore.fetchChunks")
 	defer log.Span.Finish()