Clarify doc comment for PrepareReturn()

...based on Louis's feedback.
capnproto · Jan 13, 2023 · 2877e72 · 2877e72
1 parent 3b58955
commit 2877e72
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/capability.go b/capability.go
@@ -882,7 +882,9 @@ type Returner interface {
 	AllocResults(sz ObjectSize) (Struct, error)
 
 	// PrepareReturn finalizes the return message. The method call will
-	// resolve successfully if e is nil, or otherwise it will fail.
+	// resolve successfully if e is nil, or otherwise it will return an
+	// exception to the caller.
+	//
 	// PrepareReturn must be called once.
 	//
 	// After PrepareReturn is invoked, no goroutine may modify the message