Skip to content

Commit b02fad9

Browse files
authored
Merge pull request #26 from digitalocean/mdl-ovsdb-client-docs
ovsdb: add context documentation for Client
2 parents 5726a49 + 2213ead commit b02fad9

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

ovsdb/client.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ import (
3131

3232
// A Client is an OVSDB client. Clients can be customized by using OptionFuncs
3333
// in the Dial and New functions.
34+
//
35+
// All methods on the Client that accept a context.Context can use the context
36+
// to cancel or time out requests. Some methods may use the context for advanced
37+
// use cases. If this is the case, the documentation for the method will explain
38+
// these use cases.
3439
type Client struct {
3540
// NB: must 64-bit align these atomic integers, so they should appear first
3641
// in the Client structure.

0 commit comments

Comments
 (0)