d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-13 15:09:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Improve code comments clarity (#2135)

Browse Source 
Signed-off-by: stringscut <stringscut@outlook.jp>
This commit is contained in:
stringscut
2025-12-18 14:17:21 +08:00
committed by GitHub
parent 7f412e2772
commit a2c7837a63
5 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
backtester/engine/setup.go
View File

@@ -499,7 +499,7 @@ func (bt *BackTest) setupExchangeSettings(cfg *config.Config) (*exchange.Exchang
if bt.LiveDataHandler == nil { if bt.LiveDataHandler == nil {
err = bt.Funding.AddUSDTrackingData(klineData) err = bt.Funding.AddUSDTrackingData(klineData)
if err != nil && if err != nil &&
!errors.Is(err, trackingcurrencies.ErrCurrencyDoesNotContainsUSD) && !errors.Is(err, trackingcurrencies.ErrCurrencyDoesNotContainUSD) &&
!errors.Is(err, funding.ErrUSDTrackingDisabled) { !errors.Is(err, funding.ErrUSDTrackingDisabled) {
return nil, err return nil, err
} }

18
backtester/funding/trackingcurrencies/trackingcurrencies.go
View File

@@ -13,15 +13,15 @@ import (
var ( var (
// ErrCurrencyContainsUSD is raised when the currency already contains a USD equivalent // ErrCurrencyContainsUSD is raised when the currency already contains a USD equivalent
ErrCurrencyContainsUSD = errors.New("currency already contains a USD equivalent") ErrCurrencyContainsUSD = errors.New("currency already contains a USD equivalent")
// ErrCurrencyDoesNotContainsUSD is raised when the currency does not contain a USD equivalent // ErrCurrencyDoesNotContainUSD is raised when the currency does not contain a USD equivalent
ErrCurrencyDoesNotContainsUSD = errors.New("currency does not contains a USD equivalent") ErrCurrencyDoesNotContainUSD = errors.New("currency does not contain a USD equivalent")
errNilPairs = errors.New("cannot assess with nil available pairs") errNilPairs = errors.New("cannot assess with nil available pairs")
errNoMatchingPairUSDFound = errors.New("currency pair has no USD backed equivalent, cannot track price") errNoMatchingPairUSDFound = errors.New("currency pair has no USD backed equivalent, cannot track price")
errCurrencyNotFoundInPairs = errors.New("currency does not exist in available pairs") errCurrencyNotFoundInPairs = errors.New("currency does not exist in available pairs")
errNoMatchingBaseUSDFound = errors.New("base currency has no USD back equivalent, cannot track price") errNoMatchingBaseUSDFound = errors.New("base currency has no USD back equivalent, cannot track price")
errNoMatchingQuoteUSDFound = errors.New("quote currency has no USD back equivalent, cannot track price") errNoMatchingQuoteUSDFound = errors.New("quote currency has no USD back equivalent, cannot track price")
errNilPairsReceived = errors.New("nil tracking pairs received") errNilPairsReceived = errors.New("nil tracking pairs received")
errExchangeManagerRequired = errors.New("exchange manager required") errExchangeManagerRequired = errors.New("exchange manager required")
) )
// rankedUSDs is a slice of USD tracked currencies // rankedUSDs is a slice of USD tracked currencies

4
cmd/exchange_wrapper_standards/exchange_wrapper_standards_test.go
View File

@@ -613,8 +613,8 @@ var unsupportedAssets = []asset.Item{
var unsupportedExchangeNames = []string{ var unsupportedExchangeNames = []string{
"testexch", "testexch",
"bitflyer", // Bitflyer has many "ErrNotYetImplemented, which is true, but not what we care to test for here "bitflyer", // Bitflyer has many "ErrNotYetImplemented, which is true, but not what we care to test for here
"btse", // TODO rm once timeout issues resolved "btse", // TODO rm once timeout issues resolved
"poloniex", // outdated API // TODO rm once updated "poloniex", // outdated API // TODO rm once updated
} }
// cryptoChainPerExchange holds the deposit address chain per exchange // cryptoChainPerExchange holds the deposit address chain per exchange

2
common/common.go
View File

@@ -198,7 +198,7 @@ func StringSliceContainsInsensitive(haystack []string, needle string) bool {
}) })
} }
// IsEnabled takes in a boolean param and returns a string if it is enabled // IsEnabled takes in a boolean param and returns a string if it is enabled
// or disabled // or disabled
func IsEnabled(isEnabled bool) string { func IsEnabled(isEnabled bool) string {
if isEnabled { if isEnabled {

2
currency/coinmarketcap/coinmarketcap.go
View File

@@ -300,7 +300,7 @@ func (c *Coinmarketcap) GetCryptocurrencyOHLCLatest(currencyID int64) (Cryptocur
return resp.Data, nil return resp.Data, nil
} }
// GetCryptocurrencyLatestQuotes returns the latest market quote for 1 or more // GetCryptocurrencyLatestQuotes returns the latest market quote for 1 or more
// cryptocurrencies. // cryptocurrencies.
// //
// currencyID - refers to the coinmarketcap currency id // currencyID - refers to the coinmarketcap currency id