Skip to content

Commit

Permalink
Add comments to exported methods
Browse files Browse the repository at this point in the history
  • Loading branch information
ishank011 committed Feb 2, 2022
1 parent 238a68d commit c3b3f80
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions pkg/share/cache/memory/memory.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ type manager struct {
cache gcache.Cache
}

// New returns an implementation of a resource info cache that stores the objects in memory
func New(m map[string]interface{}) (cache.ResourceInfoCache, error) {
c := &config{}
if err := mapstructure.Decode(m, c); err != nil {
Expand Down
1 change: 1 addition & 0 deletions pkg/share/cache/redis/redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type manager struct {
redisPool *redis.Pool
}

// New returns an implementation of a resource info cache that stores the objects in a redis cluster
func New(m map[string]interface{}) (cache.ResourceInfoCache, error) {
c := &config{}
if err := mapstructure.Decode(m, c); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion pkg/share/cache/warmup/cbox/cbox.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func parseConfig(m map[string]interface{}) (*config, error) {
return c, nil
}

// New returns a new implementation of the storage.FS interface that connects to EOS.
// New returns an implementation of cache warmup that connects to the cbox share db and stats resources on EOS
func New(m map[string]interface{}) (cache.Warmup, error) {
c, err := parseConfig(m)
if err != nil {
Expand Down

0 comments on commit c3b3f80

Please sign in to comment.