From a5e9d34ebd6e72ff37b45130e59c821740a2772c Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Wed, 3 Apr 2019 01:12:47 +0900 Subject: [PATCH] improve the documentation for Stream.Context() --- interface.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/interface.go b/interface.go index 95842073..a83d09b8 100644 --- a/interface.go +++ b/interface.go @@ -61,7 +61,8 @@ type Stream interface { // When called multiple times or after reading the io.EOF it is a no-op. CancelRead(ErrorCode) // The context is canceled as soon as the write-side of the stream is closed. - // This happens when Close() is called, or when the stream is reset (either locally or remotely). + // This happens when Close() or CancelWrite() is called, or when the peer + // cancels the read-side of their stream. // Warning: This API should not be considered stable and might change soon. Context() context.Context // SetReadDeadline sets the deadline for future Read calls and