From d79386365e1e906c15a295c11d89ea1db47d42f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ra=C3=BAl=20Kripalani?= <raulk@apache.org>
Date: Wed, 5 Sep 2018 15:14:40 +0100
Subject: [PATCH] rename NewPeerstoreWith(...) => NewPeerstore(...); adjust
 godoc.

---
 peerstore.go           | 7 ++++---
 pstoreds/addr_book.go  | 4 ++--
 pstoreds/peerstore.go  | 2 +-
 pstoremem/peerstore.go | 2 +-
 4 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/peerstore.go b/peerstore.go
index 047926d..c09743b 100644
--- a/peerstore.go
+++ b/peerstore.go
@@ -20,12 +20,13 @@ type peerstore struct {
 	protolock sync.Mutex
 }
 
-// NewPeerstore creates a threadsafe collection of peers.
-func NewPeerstoreWith(kb KeyBook, ab AddrBook, md PeerMetadata) Peerstore {
+// NewPeerstore creates a data structure that stores peer data, backed by the
+// supplied implementations of KeyBook, AddrBook and PeerMetadata.
+func NewPeerstore(kb KeyBook, ab AddrBook, md PeerMetadata) Peerstore {
 	return &peerstore{
 		KeyBook:      kb,
-		PeerMetadata: md,
 		AddrBook:     ab,
+		PeerMetadata: md,
 		Metrics:      NewMetrics(),
 	}
 }
diff --git a/pstoreds/addr_book.go b/pstoreds/addr_book.go
index 2db922a..90f147f 100644
--- a/pstoreds/addr_book.go
+++ b/pstoreds/addr_book.go
@@ -24,7 +24,7 @@ var dsWriteRetries = 5
 
 var _ pstore.AddrBook = (*dsAddrBook)(nil)
 
-// dsAddrBook is an address manager backed by a Datastore with both an
+// dsAddrBook is an address book backed by a Datastore with both an
 // in-memory TTL manager and an in-memory address stream manager.
 type dsAddrBook struct {
 	cache       *lru.ARCCache
@@ -33,7 +33,7 @@ type dsAddrBook struct {
 	subsManager *pstoremem.AddrSubManager
 }
 
-// NewAddrBook initializes a new address manager given a
+// NewAddrBook initializes a new address book given a
 // Datastore instance, a context for managing the TTL manager,
 // and the interval at which the TTL manager should sweep the Datastore.
 func NewAddrBook(ctx context.Context, ds ds.Batching, ttlInterval time.Duration) (*dsAddrBook, error) {
diff --git a/pstoreds/peerstore.go b/pstoreds/peerstore.go
index 9423df6..e973988 100644
--- a/pstoreds/peerstore.go
+++ b/pstoreds/peerstore.go
@@ -17,6 +17,6 @@ func NewPeerstore(ctx context.Context, ds datastore.Batching) (pstore.Peerstore,
 		return nil, err
 	}
 
-	ps := pstore.NewPeerstoreWith(pstoremem.NewKeyBook(), addrBook, pstoremem.NewPeerMetadata())
+	ps := pstore.NewPeerstore(pstoremem.NewKeyBook(), addrBook, pstoremem.NewPeerMetadata())
 	return ps, nil
 }
diff --git a/pstoremem/peerstore.go b/pstoremem/peerstore.go
index f8fde4f..7d87313 100644
--- a/pstoremem/peerstore.go
+++ b/pstoremem/peerstore.go
@@ -4,7 +4,7 @@ import pstore "github.com/libp2p/go-libp2p-peerstore"
 
 // NewPeerstore creates an in-memory threadsafe collection of peers.
 func NewPeerstore() pstore.Peerstore {
-	return pstore.NewPeerstoreWith(
+	return pstore.NewPeerstore(
 		NewKeyBook(),
 		NewAddrBook(),
 		NewPeerMetadata())