package-level comments

pkg/pagerank/pagerank.go

@@ -1,3 +1,5 @@
+// The pagerank package uses the random walks to compute graph algorithms like
+// global and personalized pageranks.
 package pagerank
 
 import (

pkg/redb/graph.go

@@ -1,3 +1,5 @@
+// The package redb defines the redis implementation of the database, which stores
+// graph relationships (e.g. follows) as well as random walks.
 package redb
 
 import (

pkg/walks/walks.go

@@ -1,3 +1,4 @@
+// The walks package is responsible for defining, generating, removing and updating random walks.
 package walks
 
 import (
@@ -13,7 +14,7 @@ var (
 	Alpha = 0.85 // the dampening factor
 	N     = 100  // the walks per node
 
-	ErrInvalidRemoval = errors.New(fmt.Sprintf("the walks to be removed are different than the expected number %d", N))
+	ErrInvalidRemoval = errors.New("the walks to be removed are different than the expected number (100)")
 )
 
 // ID represent how walks are identified in the storage layer