style(index): update tsdoc

typegoose · Jun 1, 2022 · 3f3723a · 3f3723a
1 parent c10271b
commit 3f3723a
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -4,8 +4,8 @@ import { logger } from './logSettings';
 import type { BeAnObject, IIndexArray, IndexOptions } from './types';
 
 /**
- * Defines an index (most likely compound) for this schema.
- * @param fields Which fields to give the Options
+ * Defines a index for this Class which will then be added to the Schema.
+ * @param fields Which fields to index (if multiple fields are set, it will be a compound index)
  * @param options Options to pass to MongoDB driver's createIndex() function
  * @example Example:
  * ```ts