docs: quick update to syncIndexes() docs

Automattic · Aug 23, 2023 · 0f939e2 · 0f939e2
1 parent bc2e02d
commit 0f939e2
Showing 1 changed file with 1 addition and 3 deletions.
diff --git a/lib/model.js b/lib/model.js
@@ -1481,9 +1481,7 @@ Model.syncIndexes = async function syncIndexes(options) {
 };
 
 /**
- * Does a dry-run of Model.syncIndexes(), meaning that
- * the result of this function would be the result of
- * Model.syncIndexes().
+ * Does a dry-run of `Model.syncIndexes()`, returning the indexes that `syncIndexes()` would drop and create if you were to run `syncIndexes()`.
  *
  * @param {Object} [options]
  * @returns {Promise} which contains an object, {toDrop, toCreate}, which