Add comments to Location struct

Closes #596
2017-05-25 08:23:39 -07:00 · 2017-05-25 08:23:39 -07:00 · 875e19ebd9
parent 67bef4e679
commit 875e19ebd9
1 changed files with 5 additions and 0 deletions
--- a/search/search.go
+++ b/search/search.go
@ -36,9 +36,14 @@ func (ap ArrayPositions) Equals(other ArrayPositions) bool {
 }

 type Location struct {
+	// Pos is the position of the term within the field, starting at 1
 	Pos            uint64         `json:"pos"`
+	
+	// Start and End are the character offsets of the term in the field
 	Start          uint64         `json:"start"`
 	End            uint64         `json:"end"`
+	
+	// ArrayPositions contains the positions of the term within each array of subdocuments.
 	ArrayPositions ArrayPositions `json:"array_positions"`
 }