From 39fa1ffe9b5c21de333d1bea72fcee7a5e08ae5a Mon Sep 17 00:00:00 2001 From: Caleb Doxsey Date: Wed, 1 Aug 2018 11:19:19 -0400 Subject: [PATCH] contrib/bradfitz/gomemcache: add documentation --- contrib/bradfitz/gomemcache/memcache/memcache.go | 8 +++++++- contrib/bradfitz/gomemcache/memcache/option.go | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/contrib/bradfitz/gomemcache/memcache/memcache.go b/contrib/bradfitz/gomemcache/memcache/memcache.go index ac2093ee2a..a68e822384 100644 --- 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 index 7fbe673374..8bcb57a235 100644 --- 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"