add some coms

Author: millotp

templates/go/api.mustache

@@ -104,12 +104,14 @@ func (c chunkedBatchOption) chunkedBatch() {}
 
 func (r requestOption) chunkedBatch() {}
 
+// WithWaitForTasks whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
 func WithWaitForTasks(waitForTasks bool) chunkedBatchOption {
 	return chunkedBatchOption(func(c *config) {
 		c.waitForTasks = waitForTasks
 	})
 }
 
+// WithBatchSize the size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
 func WithBatchSize(batchSize int) chunkedBatchOption {
 	return chunkedBatchOption(func(c *config) {
 		c.batchSize = batchSize
@@ -143,6 +145,7 @@ func (c chunkedBatchOption) partialUpdateObjects() {}
 
 func (r requestOption) partialUpdateObjects() {}
 
+// WithCreateIfNotExists to be provided if non-existing objects are passed, otherwise, the call will fail.
 func WithCreateIfNotExists(createIfNotExists bool) partialUpdateObjectsOption {
 	return partialUpdateObjectsOption(func(c *config) {
 		c.createIfNotExists = createIfNotExists
@@ -176,6 +179,7 @@ func (c chunkedBatchOption) replaceAllObjects() {}
 
 func (r requestOption) replaceAllObjects() {}
 
+// WithScopes the `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
 func WithScopes(scopes []ScopeType) replaceAllObjectsOption {
 	return replaceAllObjectsOption(func(c *config) {
 		c.scopes = scopes
@@ -204,18 +208,21 @@ func (r requestOption) iterable() {}
 
 func (i iterableOption) iterable() {}
 
+// WithMaxRetries the maximum number of retry. Default to 50.
 func WithMaxRetries(maxRetries int) iterableOption {
 	return iterableOption(func(c *config) {
 		c.maxRetries = maxRetries
 	})
 }
 
+// WithTimeout he function to decide how long to wait between retries. Default to min(retryCount * 200, 5000)
 func WithTimeout(timeout func(int) time.Duration) iterableOption {
 	return iterableOption(func(c *config) {
 		c.timeout = timeout
 	})
 }
 
+// WithAggregator the function to aggregate the results of the iterable.
 func WithAggregator(aggregator func(any, error)) iterableOption {
 	return iterableOption(func(c *config) {
 		c.aggregator = aggregator
@@ -249,6 +256,7 @@ func (r requestOption) waitForApiKey() {}
 
 func (i iterableOption) waitForApiKey() {}
 
+// WithApiKey necessary to know if an `update` operation has been processed, compare fields of the response with it. (optional - mandatory if operation is UPDATE)
 func WithApiKey(apiKey *ApiKey) waitForApiKeyOption {
 	return waitForApiKeyOption(func(c *config) {
 		c.apiKey = apiKey