github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge pull request #2139 from estesp/godoc-typo

Browse Source 
Clean up client Subscribe docs; remove a typo
This commit is contained in:
Kenfe-Mickaël Laventure
2018-02-16 07:46:44 -08:00
committed by GitHub
parent 849fed09e3 18be82118d
commit 1392ad2b54
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
client.go
View File

@@ -338,11 +338,11 @@ func (c *Client) ListImages(ctx context.Context, filters ...string) ([]Image, er
// Subscribe to events that match one or more of the provided filters. // Subscribe to events that match one or more of the provided filters.
// //
// Callers should listen on both the envelope channel and errs channel. If the // Callers should listen on both the envelope and errs channels. If the errs
// errs channel returns nil or an error, the subscriber should terminate. // channel returns nil or an error, the subscriber should terminate.
// //
// To cancel shutdown reciept of events, cancel the provided context. The errs // The subscriber can stop receiving events by canceling the provided context.
// channel will be closed and return a nil error. // The errs channel will be closed and return a nil error.
func (c *Client) Subscribe(ctx context.Context, filters ...string) (ch <-chan *eventsapi.Envelope, errs <-chan error) { func (c *Client) Subscribe(ctx context.Context, filters ...string) (ch <-chan *eventsapi.Envelope, errs <-chan error) {
var ( var (
evq = make(chan *eventsapi.Envelope) evq = make(chan *eventsapi.Envelope)