Browse Source

improve doc for dataprovider Close method

the method is used in test cases, it assumes that the dataprovider
is initialized and it is not safe Initialize/Close from different
goroutines
Nicola Murino 5 years ago
parent
commit
fb8ccfe824
1 changed files with 3 additions and 1 deletions
  1. 3 1
      dataprovider/dataprovider.go

+ 3 - 1
dataprovider/dataprovider.go

@@ -259,7 +259,9 @@ func GetUserByID(p Provider, ID int64) (User, error) {
 	return p.getUserByID(ID)
 }
 
-// Close releases all database resources
+// Close releases all provider resources.
+// This method is used in test cases.
+// Closing an uninitialized provider is not supported
 func Close(p Provider) error {
 	availabilityTicker.Stop()
 	availabilityTickerDone <- true