From 011291f19bdce0800a2a6391e4eb7076cd285ed7 Mon Sep 17 00:00:00 2001
From: Samir Patel <48686912+54mir@users.noreply.github.com>
Date: Fri, 11 Jun 2021 11:28:39 -0500
Subject: [PATCH] update comments

---
 api.go | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/api.go b/api.go
index 79c6573ee..0ff042165 100644
--- a/api.go
+++ b/api.go
@@ -952,7 +952,7 @@ type MemoryUsage struct {
 	TotalUse uint64 `json:"totalInUse"`
 }
 
-// Returns disk usage from cache if cache is large. It will recalculate on the spot of the last cacluation was under 5 seconds.
+// Returns disk usage from cache if cache is large. It will recalculate on the spot if the last cacluation was under 5 seconds.
 func (api *API) Usage(ctx context.Context, remote bool) (map[string]NodeUsage, error) {
 	span, _ := tracing.StartSpanFromContext(ctx, "API.Usage")
 	defer span.Finish()
@@ -960,7 +960,7 @@ func (api *API) Usage(ctx context.Context, remote bool) (map[string]NodeUsage, e
 	if api.usageCache.lastCalcDuration < (time.Second * 5) {
 		err := api.ResetUsageCache()
 		if err != nil {
-			api.server.logger.Infof("data detected but could not recalculate cache: %s", err)
+			api.server.logger.Infof("could not reset cache: %s", err)
 		}
 	}
 
@@ -997,7 +997,7 @@ func (api *API) requestUsageOfNodes() {
 	}
 }
 
-// Calculates disk usage from scratch for each index and stores the results in the usage cache
+// Calculates disk usage from scratch if cache has expired for each index and stores the results in the usage cache
 func (api *API) calculateUsage() {
 	api.usageCache.muCalculate.Lock()
 	defer api.usageCache.muCalculate.Unlock()
@@ -1086,6 +1086,7 @@ func (api *API) RefreshUsageCache() {
 	}
 }
 
+// Refresh interval set in relation to how long the last calculation took.
 func (api *API) setRefreshInterval(dur time.Duration) {
 	refresh := dur * api.usageCache.waitMultiplier
 	if refresh < time.Hour {