Skip to content

Commit

Permalink
channel: fix documentation of the Close method of Channel
Browse files Browse the repository at this point in the history
The comment incorrectly stated that Close affects both sends and receives, when
in fact it only affects sends. The receives affected by Close are at the other
end of the channel pair.

Updates #108.
  • Loading branch information
creachadair committed Sep 15, 2023
1 parent 993a9f7 commit 1f1536c
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions channel/channel.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ type Channel interface {
// fetches a single complete record.
Recv() ([]byte, error)

// Close shuts down the channel, after which no further records may be
// sent or received.
// Close shuts down the channel, after which no further records may be sent.
Close() error
}

Expand Down

0 comments on commit 1f1536c

Please sign in to comment.