Add additional information to the docstring.

dustinhiatt-wf · dustinhiatt-wf · commit 5c1be35041bf · 2015-10-09T08:38:36.000-05:00
diff --git a/rangetree/interface.go b/rangetree/interface.go
@@ -35,7 +35,8 @@ type Entry interface {
 	ValueAtDimension(dimension uint64) int64
 }
 
-// Interval describes the methods required to query the rangetree.
+// Interval describes the methods required to query the rangetree.  Note that
+// all ranges are inclusive.
 type Interval interface {
 	// LowAtDimension returns an integer representing the lower bound
 	// at the requested dimension.

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ type Entry interface {`
`35`	`35`	`ValueAtDimension(dimension uint64) int64`
`36`	`36`	`}`
`37`	`37`
`38`		`-// Interval describes the methods required to query the rangetree.`
	`38`	`+// Interval describes the methods required to query the rangetree. Note that`
	`39`	`+// all ranges are inclusive.`
`39`	`40`	`type Interval interface {`
`40`	`41`	`// LowAtDimension returns an integer representing the lower bound`
`41`	`42`	`// at the requested dimension.`