doc: document semantics of Result/Error

80bb555d · Steven Allen · bce485ce · 80bb555d
Commit 80bb555d authored Apr 06, 2019 by Steven Allen
Show whitespace changes
Inline Side-by-side

Showing with 2 additions and 1 deletion

query/query.go query/query.go +2 -1

No files found.
--- a/query/query.go
+++ b/query/query.go
@@ -75,7 +75,8 @@ type Entry struct {
 }

 // Result is a special entry that includes an error, so that the client
-// may be warned about internal errors.
+// may be warned about internal errors. If Error is non-nil, Entry must be
+// empty.
 type Result struct {
 	Entry