From 65c4ea5d77b2b8b801a39bcd4e601fdc34c70b8f Mon Sep 17 00:00:00 2001 From: "Derrick J. Wippler" Date: Thu, 19 Nov 2020 20:12:15 -0600 Subject: [PATCH] Clarify the use of `groupcache.NewHTTPPoolOpts()` in the documentation Fixes #20 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b968f7..fd1ec51 100644 --- a/README.md +++ b/README.md @@ -149,4 +149,5 @@ func ExampleUsage() { } ``` - +### Note +The call to `groupcache.NewHTTPPoolOpts()` is a bit misleading. `NewHTTPPoolOpts()` creates a new pool internally within the `groupcache` package where it is uitilized by any groups created. The `pool` returned is only a pointer to the internallly registered pool so the caller can update the peers in the pool as needed.