feat(gcr/s) comment

a6710e9f · Brian Tiger Chow · 5caa179d · a6710e9f
Commit a6710e9f authored 10 years ago by Brian Tiger Chow
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 1 deletion

core/corerouting/core.go core/corerouting/core.go +3 -1

No files found.
--- a/core/corerouting/core.go
+++ b/core/corerouting/core.go
@@ -23,7 +23,9 @@ var (
 	errServersMissing   = errors.New("grandcentral client requires at least 1 server peer")
 )

-// TODO doc
+// GrandCentralServer returns a configuration for a routing server that stores
+// routing records to the provided datastore. Only routing records are store in
+// the datastore.
 func GrandCentralServer(recordSource datastore.ThreadSafeDatastore) core.RoutingOption {
 	return func(ctx context.Context, node *core.IpfsNode) (routing.IpfsRouting, error) {
 		if node.Peerstore == nil {