Skip to content

Commit d763751

Browse files
committed
Update docstrings for methods
1 parent 5efb23e commit d763751

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/collections/tenants/index.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -191,31 +191,31 @@ export interface Tenants {
191191
* For details on the new activity statuses, see the docstring for the `Tenants` interface type.
192192
*
193193
* @param {TenantInput | TenantInput[]} tenants The tenant or tenants to update.
194-
* @returns {Promise<Tenant[]>} The updated tenant(s) as a list of Tenant.
194+
* @returns {Promise<Tenant[]>} The updated tenants as a list of Tenant.
195195
*/
196196
update: (tenants: TenantBC | TenantUpdate | (TenantBC | TenantUpdate)[]) => Promise<Tenant[]>;
197197
/**
198-
* Activate the specified tenant for a collection in Weaviate.
198+
* Activate the specified tenants for a collection in Weaviate.
199199
* The collection must have been created with multi-tenancy enabled.
200200
*
201-
* @param {string | TenantBase | (string | TenantBase)[]} tenant The tenant to activate.
202-
* @returns {Promise<Tenant[]>} The activated tenant as a list of Tenant.
201+
* @param {string | TenantBase | (string | TenantBase)[]} tenant The tenants to activate.
202+
* @returns {Promise<Tenant[]>} The list of Tenants that have been activated.
203203
*/
204-
activate: (tenant: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
204+
activate: (tenants: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
205205
/**
206-
* Deactivate the specified tenant for a collection in Weaviate.
206+
* Deactivate the specified tenants for a collection in Weaviate.
207207
* The collection must have been created with multi-tenancy enabled.
208208
*
209-
* @param {string | TenantBase | (string | TenantBase)[]} tenant The tenant to deactivate.
210-
* @returns {Promise<Tenant[]>} The deactivated tenant as a list of Tenant
209+
* @param {string | TenantBase | (string | TenantBase)[]} tenants The tenants to deactivate.
210+
* @returns {Promise<Tenant[]>} The list of Tenants that have been deactivated.
211211
*/
212-
deactivate: (tenant: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
212+
deactivate: (tenants: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
213213
/**
214-
* Offload the specified tenant for a collection in Weaviate.
214+
* Offload the specified tenants for a collection in Weaviate.
215215
* The collection must have been created with multi-tenancy enabled.
216216
*
217-
* @param {string | TenantBase | (string | TenantBase)[]} tenant The tenant to offload.
218-
* @returns {Promise<Tenant[]>} The offloaded tenant as a list of Tenant
217+
* @param {string | TenantBase | (string | TenantBase)[]} tenants The tenants to offload.
218+
* @returns {Promise<Tenant[]>} The list of Tenants that have been offloaded.
219219
*/
220-
offload: (tenant: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
220+
offload: (tenants: string | TenantBase | (string | TenantBase)[]) => Promise<Tenant[]>;
221221
}

0 commit comments

Comments
 (0)