refactor: Update function comments to follow consistent naming conventions (thrasher-corp#2155)

* refactor: update function comments to follow consistent naming conventions

- Changed comments for various functions across multiple files to use lowercase for function names.
- Improved clarity of comments to better describe the functionality of the respective functions.
- Removed unnecessary comments that do not add value or context to the code.

* Update exchanges/bitmex/bitmex_websocket.go

Co-authored-by: Scott <gloriousCode@users.noreply.github.com>

* refactor: remove outdated benchmark comments and improve clarity in test descriptions

---------

Co-authored-by: Scott <gloriousCode@users.noreply.github.com>

Author: thrasher-

backtester/data/data_test.go

@@ -586,7 +586,6 @@ func TestLast(t *testing.T) {
 	assert.Equal(t, id3, last.GetOffset())
 }
 
-// methods that satisfy the common.Event interface
 func (f fakeEvent) GetOffset() int64 {
 	if f.secretID > 0 {
 		return f.secretID

backtester/funding/funding.go

@@ -481,7 +481,7 @@ func (f *FundManager) GetFundingForEvent(ev common.Event) (IFundingPair, error)
 	return f.getFundingForEAP(ev.GetExchange(), ev.GetAssetType(), ev.Pair())
 }
 
-// GetFundingForEAP This will construct a funding based on the exchange, asset, currency pair
+// getFundingForEAP constructs a funding based on the exchange, asset, currency pair
 func (f *FundManager) getFundingForEAP(exch string, a asset.Item, p currency.Pair) (IFundingPair, error) {
 	if a.IsFutures() {
 		var collat CollateralPair

common/cache/cache.go

@@ -21,7 +21,7 @@ func (l *LRUCache) Get(key any) (value any) {
 	return l.lru.Get(key)
 }
 
-// GetOldest looks up old key's value from the cache.
+// getOldest looks up old key's value from the cache
 func (l *LRUCache) getOldest() (key, value any) {
 	l.m.Lock()
 	defer l.m.Unlock()

common/cache/lru.go

@@ -49,7 +49,7 @@ func (l *LRU) Get(key any) any {
 	return nil
 }
 
-// GetOldest returns the oldest entry
+// getOldest returns the oldest entry
 func (l *LRU) getOldest() (key, value any) {
 	if x := l.l.Back(); x != nil {
 		if v, ok := x.Value.(*item); ok {
@@ -59,7 +59,7 @@ func (l *LRU) getOldest() (key, value any) {
 	return
 }
 
-// GetNewest returns the newest entry
+// getNewest returns the newest entry
 func (l *LRU) getNewest() (key, value any) {
 	if x := l.l.Front(); x != nil {
 		if v, ok := x.Value.(*item); ok {

connchecker/connchecker.go

@@ -130,7 +130,7 @@ func (c *Checker) initialCheck() error {
 	return nil
 }
 
-// ConnectionTest determines if a connection to the internet is available by
+// connectionTest determines if a connection to the internet is available by
 // iterating over a set list of dns ip and popular domains
 func (c *Checker) connectionTest() {
 	for i := range c.DNSList {

currency/coinmarketcap/coinmarketcap_test.go

@@ -15,8 +15,6 @@ const (
 	apiAccountPlanLevel = ""
 )
 
-// Checks credentials but also checks to see if the function can take the
-// required account plan level
 func areAPICredtionalsSet(minAllowable uint8) bool {
 	if apiAccountPlanLevel != "" && apikey != "" {
 		if err := c.CheckAccountPlan(minAllowable); err != nil {

dispatch/dispatch.go

@@ -227,7 +227,7 @@ func (d *Dispatcher) publish(id uuid.UUID, data any) error {
 	}
 }
 
-// Subscribe subscribes a system and returns a communication chan, this does not ensure initial push.
+// subscribe subscribes a system and returns a communication chan, this does not ensure initial push
 func (d *Dispatcher) subscribe(id uuid.UUID) (chan any, error) {
 	if err := common.NilGuard(d); err != nil {
 		return nil, err
@@ -261,7 +261,7 @@ func (d *Dispatcher) subscribe(id uuid.UUID) (chan any, error) {
 	return ch, nil
 }
 
-// Unsubscribe unsubs a routine from the dispatcher.
+// unsubscribe unsubs a routine from the dispatcher
 func (d *Dispatcher) unsubscribe(id uuid.UUID, usedChan chan any) error {
 	if err := common.NilGuard(d); err != nil {
 		return err
@@ -314,7 +314,7 @@ func (d *Dispatcher) unsubscribe(id uuid.UUID, usedChan chan any) error {
 	return errChannelNotFoundInUUIDRef
 }
 
-// GetNewID returns a new ID.
+// getNewID returns a new ID
 func (d *Dispatcher) getNewID(genFn func() (uuid.UUID, error)) (uuid.UUID, error) {
 	if err := common.NilGuard(d); err != nil {
 		return uuid.Nil, err

engine/database_connection_test.go

@@ -67,7 +67,7 @@ func TestStartSQLite(t *testing.T) {
 	assert.NoError(t, err)
 }
 
-// This test does not care for a successful connection
+// TestStartPostgres does not require a successful connection
 func TestStartPostgres(t *testing.T) {
 	m, err := SetupDatabaseConnectionManager(&database.Config{})
 	assert.NoError(t, err)

engine/datahistory_manager.go

@@ -1478,7 +1478,7 @@ func (m *DataHistoryManager) GenerateJobSummary(nickname string) (*DataHistoryJo
 	}, nil
 }
 
-// ----------------------------Lovely-converters----------------------------
+// convertDBModelToJob converts a database model into a data history job
 func (m *DataHistoryManager) convertDBModelToJob(dbModel *datahistoryjob.DataHistoryJob) (*DataHistoryJob, error) {
 	if !m.IsRunning() {
 		return nil, ErrSubSystemNotStarted

engine/datahistory_manager_test.go

@@ -739,7 +739,6 @@ func TestConverters(t *testing.T) {
 	}
 }
 
-// test helper functions
 func createDHM(t *testing.T) (*DataHistoryManager, *datahistoryjob.DataHistoryJob) {
 	t.Helper()
 	em := NewExchangeManager()