contrib/bradfitz/gomemcache: add documentation

DataDog · Aug 1, 2018 · 39fa1ff · 39fa1ff
1 parent 972fc5b
commit 39fa1ff
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/contrib/bradfitz/gomemcache/memcache/memcache.go b/contrib/bradfitz/gomemcache/memcache/memcache.go
@@ -1,4 +1,10 @@
-package memcache
+// Package memcache provides functions to trace the bradfitz/gomemcache package (https://github.com/bradfitz/gomemcache).
+//
+// `WrapClient` will wrap a memcache `Client` and return a new struct with all
+// the same methods, so should be seamless for existing applications. It also
+// has an additional `WithContext` method which can be used to connect a span
+// to an existing trace.
+package memcache // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/bradfitz/gomemcache/memcache"
 
 import (
 	"context"

diff --git a/contrib/bradfitz/gomemcache/memcache/option.go b/contrib/bradfitz/gomemcache/memcache/option.go
@@ -1,4 +1,4 @@
-package memcache // import "gopkg.in/DataDog/dd-trace-go.v1/contrib/bradfitz/gomemcache/memcache"
+package memcache
 
 const (
 	serviceName   = "memcached"