Fix function comments based on best practices from Effective Go

Signed-off-by: CodeLingo Bot <bot@codelingo.io>
go-graphite · Feb 18, 2019 · cf60974 · cf60974
1 parent 9374c26
commit cf60974
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/cache/cache.go b/cache/cache.go
@@ -155,7 +155,7 @@ func fnv32(key string) uint32 {
 	return hash
 }
 
-// Returns shard under given key
+// GetShard returns shard under given key
 func (c *Cache) GetShard(key string) *Shard {
 	// @TODO: remove type casts?
 	return c.data[uint(fnv32(key))%uint(shardCount)]
@@ -269,7 +269,7 @@ func (c *Cache) Add(p *points.Points) {
 	atomic.AddInt32(&c.stat.size, int32(count))
 }
 
-// Removes an element from the map and returns it
+// Pop removes an element from the map and returns it
 func (c *Cache) Pop(key string) (p *points.Points, exists bool) {
 	// Try to get shard.
 	shard := c.GetShard(key)

diff --git a/carbon/config.go b/carbon/config.go
@@ -251,7 +251,7 @@ func NewConfig() *Config {
 	return cfg
 }
 
-// PrintConfig ...
+// PrintDefaultConfig ...
 func PrintDefaultConfig() error {
 	cfg := NewConfig()
 	buf := new(bytes.Buffer)