From 213c639ed67ac494a7484d0a90e93eb06ef56866 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Timoth=C3=A9e=20Rebours?= <tim@seald.io>
Date: Fri, 7 Jan 2022 05:26:45 +0100
Subject: [PATCH] cleanup JSDoc

---
 docs/Datastore.md | 28 ++++++++++++---------------
 lib/datastore.js  | 48 +++++++++++++++++++++++------------------------
 2 files changed, 36 insertions(+), 40 deletions(-)

diff --git a/docs/Datastore.md b/docs/Datastore.md
index 25aef46..bd2a3f7 100644
--- a/docs/Datastore.md
+++ b/docs/Datastore.md
@@ -434,14 +434,12 @@ interpreted as the callback.</p>
 
 - query [<code>query</code>](#query) - <p>is the same kind of finding query you use with <code>find</code> and <code>findOne</code></p>
 - update [<code>document</code>](#document) | <code>\*</code> - <p>specifies how the documents should be modified. It is either a new document or a
-set of modifiers (you cannot use both together, it doesn't make sense!):</p>
-<ul>
-<li>A new document will replace the matched docs</li>
-<li>The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-Available field modifiers are <code>$set</code> to change a field's value, <code>$unset</code> to delete a field, <code>$inc</code> to increment a
-field's value and <code>$min</code>/<code>$max</code> to change field's value, only if provided value is less/greater than current
-value. To work on arrays, you have <code>$push</code>, <code>$pop</code>, <code>$addToSet</code>, <code>$pull</code>, and the special <code>$each</code> and <code>$slice</code>.</li>
-</ul>
+set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+apply them to subdocs. Available field modifiers are <code>$set</code> to change a field's value, <code>$unset</code> to delete a field,
+<code>$inc</code> to increment a field's value and <code>$min</code>/<code>$max</code> to change field's value, only if provided value is
+less/greater than current value. To work on arrays, you have <code>$push</code>, <code>$pop</code>, <code>$addToSet</code>, <code>$pull</code>, and the special
+<code>$each</code> and <code>$slice</code>.</p>
 - [options|] <code>Object</code> | [<code>updateCallback</code>](#Datastore..updateCallback) - <p>Optional options</p>
     - [.multi] <code>boolean</code> <code> = false</code> - <p>If true, can update multiple documents</p>
     - [.upsert] <code>boolean</code> <code> = false</code> - <p>If true, can insert a new document corresponding to the <code>update</code> rules if
@@ -464,14 +462,12 @@ if the update did not actually modify them.</p>
 
 - query [<code>query</code>](#query) - <p>is the same kind of finding query you use with <code>find</code> and <code>findOne</code></p>
 - update [<code>document</code>](#document) | <code>\*</code> - <p>specifies how the documents should be modified. It is either a new document or a
-set of modifiers (you cannot use both together, it doesn't make sense!):</p>
-<ul>
-<li>A new document will replace the matched docs</li>
-<li>The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-Available field modifiers are <code>$set</code> to change a field's value, <code>$unset</code> to delete a field, <code>$inc</code> to increment a
-field's value and <code>$min</code>/<code>$max</code> to change field's value, only if provided value is less/greater than current
-value. To work on arrays, you have <code>$push</code>, <code>$pop</code>, <code>$addToSet</code>, <code>$pull</code>, and the special <code>$each</code> and <code>$slice</code>.</li>
-</ul>
+set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+apply them to subdocs. Available field modifiers are <code>$set</code> to change a field's value, <code>$unset</code> to delete a field,
+<code>$inc</code> to increment a field's value and <code>$min</code>/<code>$max</code> to change field's value, only if provided value is
+less/greater than current value. To work on arrays, you have <code>$push</code>, <code>$pop</code>, <code>$addToSet</code>, <code>$pull</code>, and the special
+<code>$each</code> and <code>$slice</code>.</p>
 - [options] <code>Object</code> <code> = {}</code> - <p>Optional options</p>
     - [.multi] <code>boolean</code> <code> = false</code> - <p>If true, can update multiple documents</p>
     - [.upsert] <code>boolean</code> <code> = false</code> - <p>If true, can insert a new document corresponding to the <code>update</code> rules if
diff --git a/lib/datastore.js b/lib/datastore.js
index 63e4a71..a64daef 100755
--- a/lib/datastore.js
+++ b/lib/datastore.js
@@ -852,12 +852,12 @@ class Datastore extends EventEmitter {
    * Use {@link Datastore#update} which has the same signature.
    * @param {query} query is the same kind of finding query you use with `find` and `findOne`
    * @param {document|update} update specifies how the documents should be modified. It is either a new document or a
-   * set of modifiers (you cannot use both together, it doesn't make sense!):
-   *  - A new document will replace the matched docs
-   *  - The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-   *  Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a
-   *  field's value and `$min`/`$max` to change field's value, only if provided value is less/greater than current
-   *  value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`.
+   * set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+   * matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+   * apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field,
+   * `$inc` to increment a field's value and `$min`/`$max` to change field's value, only if provided value is
+   * less/greater than current value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special
+   * `$each` and `$slice`.
    * @param {object} [options] Optional options. If not given, is interpreted as the callback.
    * @param {boolean} [options.multi = false] If true, can update multiple documents
    * @param {boolean} [options.upsert = false] If true, can insert a new document corresponding to the `update` rules if
@@ -884,12 +884,12 @@ class Datastore extends EventEmitter {
    * Use {@link Datastore#updateAsync} which has the same signature.
    * @param {query} query is the same kind of finding query you use with `find` and `findOne`
    * @param {document|update} update specifies how the documents should be modified. It is either a new document or a
-   * set of modifiers (you cannot use both together, it doesn't make sense!):
-   *  - A new document will replace the matched docs
-   *  - The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-   *  Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a
-   *  field's value and `$min`/`$max` to change field's value, only if provided value is less/greater than current
-   *  value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`.
+   * set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+   * matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+   * apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field,
+   * `$inc` to increment a field's value and `$min`/`$max` to change field's value, only if provided value is
+   * less/greater than current value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special
+   * `$each` and `$slice`.
    * @param {Object} options options
    * @param {boolean} [options.multi = false] If true, can update multiple documents
    * @param {boolean} [options.upsert = false] If true, can insert a new document corresponding to the `update` rules if
@@ -972,12 +972,12 @@ class Datastore extends EventEmitter {
    * Update all docs matching query.
    * @param {query} query is the same kind of finding query you use with `find` and `findOne`
    * @param {document|*} update specifies how the documents should be modified. It is either a new document or a
-   * set of modifiers (you cannot use both together, it doesn't make sense!):
-   *  - A new document will replace the matched docs
-   *  - The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-   *  Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a
-   *  field's value and `$min`/`$max` to change field's value, only if provided value is less/greater than current
-   *  value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`.
+   * set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+   * matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+   * apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field,
+   * `$inc` to increment a field's value and `$min`/`$max` to change field's value, only if provided value is
+   * less/greater than current value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special
+   * `$each` and `$slice`.
    * @param {Object|Datastore~updateCallback} [options|] Optional options
    * @param {boolean} [options.multi = false] If true, can update multiple documents
    * @param {boolean} [options.upsert = false] If true, can insert a new document corresponding to the `update` rules if
@@ -1003,12 +1003,12 @@ class Datastore extends EventEmitter {
    * Async version of {@link Datastore#update}.
    * @param {query} query is the same kind of finding query you use with `find` and `findOne`
    * @param {document|*} update specifies how the documents should be modified. It is either a new document or a
-   * set of modifiers (you cannot use both together, it doesn't make sense!):
-   *  - A new document will replace the matched docs
-   *  - The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs.
-   *  Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a
-   *  field's value and `$min`/`$max` to change field's value, only if provided value is less/greater than current
-   *  value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`.
+   * set of modifiers (you cannot use both together, it doesn't make sense!). Using a new document will replace the
+   * matched docs. Using a set of modifiers will create the fields they need to modify if they don't exist, and you can
+   * apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field,
+   * `$inc` to increment a field's value and `$min`/`$max` to change field's value, only if provided value is
+   * less/greater than current value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special
+   * `$each` and `$slice`.
    * @param {Object} [options = {}] Optional options
    * @param {boolean} [options.multi = false] If true, can update multiple documents
    * @param {boolean} [options.upsert = false] If true, can insert a new document corresponding to the `update` rules if