Reworded hints doc

Signed-off-by: Marco Pracucci <marco@pracucci.com>
thanos-io · Apr 23, 2020 · f348bb2 · f348bb2
1 parent 547f226
commit f348bb2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,7 @@ We use *breaking* word for marking changes that are not backward compatible (rel
 
 ### Added
 
-- [#2502](https://github.com/thanos-io/thanos/pull/2502) Added `hints_enabled` proto field to `SeriesRequest` and `hints` field to `SeriesResponse`. Hints in an opaque data structure that can be used to carry information about how the series and its content is implementation specific.
+- [#2502](https://github.com/thanos-io/thanos/pull/2502) Added `hints_enabled` proto field to `SeriesRequest` and `hints` field to `SeriesResponse`. Hints in an opaque data structure that can be used to carry additional information from the store and its content is implementation specific.
 
 ## [v0.12.1](https://github.com/thanos-io/thanos/releases/tag/v0.12.1) - 2020.04.20
 

diff --git a/pkg/store/storepb/rpc.proto b/pkg/store/storepb/rpc.proto
@@ -139,8 +139,8 @@ message SeriesResponse {
     /// It is used to warn query customer about suspicious cases or partial response (if enabled).
     string warning = 2;
 
-    /// hints in an opaque data structure that can be used to carry information about how the series
-    /// have been queried. The content of this field and whether it's supported depends on the
+    /// hints is an opaque data structure that can be used to carry additional information from
+    /// the store. The content of this field and whether it's supported depends on the
     /// implementation of a specific store. It's also implementation specific if it's allowed that
     /// multiple SeriesResponse frames contain hints for a single Series() request and how should they
     /// be handled in such case (ie. merged vs keep the first/last one).