docs(schema): improve description of .indexes()

vkarpov15 · vkarpov15 · commit 718e777652c0 · 2018-01-20T14:40:02.000-08:00
diff --git a/lib/schema.js b/lib/schema.js
@@ -1403,7 +1403,8 @@ Object.defineProperty(Schema, 'indexTypes', {
 });
 
 /**
- * Compiles indexes from fields and schema-level indexes
+ * Returns a list of indexes that this schema declares, via `schema.index()`
+ * or by `index: true` in a path's options.
  *
  * @api public
  */

Original file line number	Diff line number	Diff line change
`@@ -1403,7 +1403,8 @@ Object.defineProperty(Schema, 'indexTypes', {`
`1403`	`1403`	`});`
`1404`	`1404`
`1405`	`1405`	`/**`
`1406`		`- * Compiles indexes from fields and schema-level indexes`
	`1406`	+ * Returns a list of indexes that this schema declares, via `schema.index()`
	`1407`	+ * or by `index: true` in a path's options.
`1407`	`1408`	`*`
`1408`	`1409`	`* @api public`
`1409`	`1410`	`*/`