docs: Fix return type and better wording

danez · danez · commit 00577f463d5d · 2021-04-10T13:06:18.000+02:00
Fixes #200
diff --git a/README.md b/README.md
@@ -229,7 +229,7 @@ Returns true if the given `string` contains the given pattern. Similar to [.isMa
 * `str` **{String}**: The string to match.
 * `patterns` **{String|Array}**: Glob pattern to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if the patter matches any part of `str`.
+* `returns` **{Boolean}**: Returns true if any of the patterns matches any part of `str`.
 
 **Example**
 
@@ -274,7 +274,7 @@ Returns true if some of the strings in the given `list` match any of the given g
 * `list` **{String|Array}**: The string or array of strings to test. Returns as soon as the first match is found.
 * `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if any patterns match `str`
+* `returns` **{Boolean}**: Returns true if any `patterns` matches any of the strings in `list`
 
 **Example**
 
@@ -297,7 +297,7 @@ Returns true if every string in the given `list` matches any of the given glob `
 * `list` **{String|Array}**: The string or array of strings to test.
 * `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if any patterns match `str`
+* `returns` **{Boolean}**: Returns true if all `patterns` matches all of the strings in `list`
 
 **Example**
 
@@ -354,7 +354,7 @@ Returns an array of matches captured by `pattern` in `string, or`null` if the pa
 * `glob` **{String}**: Glob pattern to use for matching.
 * `input` **{String}**: String to match
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns an array of captures if the input matches the glob pattern, otherwise `null`.
+* `returns` **{Array|null}**: Returns an array of captures if the input matches the glob pattern, otherwise `null`.
 
 **Example**
 
@@ -967,8 +967,8 @@ You might also be interested in these projects:
 | 12  | [es128](https://github.com/es128) |  
 | 8   | [doowb](https://github.com/doowb) |  
 | 6   | [paulmillr](https://github.com/paulmillr) |  
-| 5   | [danez](https://github.com/danez) |  
 | 5   | [mrmlnc](https://github.com/mrmlnc) |  
+| 4   | [danez](https://github.com/danez) |  
 | 3   | [DrPizza](https://github.com/DrPizza) |  
 | 2   | [TrySound](https://github.com/TrySound) |  
 | 2   | [mceIdo](https://github.com/mceIdo) |  
@@ -986,7 +986,6 @@ You might also be interested in these projects:
 | 1   | [sebdeckers](https://github.com/sebdeckers) |  
 | 1   | [tomByrer](https://github.com/tomByrer) |  
 | 1   | [fidian](https://github.com/fidian) |  
-| 1   | [curbengh](https://github.com/curbengh) |  
 | 1   | [simlu](https://github.com/simlu) |  
 | 1   | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |  
 | 1   | [yvele](https://github.com/yvele) |  
diff --git a/index.js b/index.js
@@ -181,7 +181,7 @@ micromatch.not = (list, patterns, options = {}) => {
  * @param {String} `str` The string to match.
  * @param {String|Array} `patterns` Glob pattern to use for matching.
  * @param {Object} `options` See available [options](#options) for changing how matches are performed
- * @return {Boolean} Returns true if the patter matches any part of `str`.
+ * @return {Boolean} Returns true if any of the patterns matches any part of `str`.
  * @api public
  */
 
@@ -252,7 +252,7 @@ micromatch.matchKeys = (obj, patterns, options) => {
  * @param {String|Array} `list` The string or array of strings to test. Returns as soon as the first match is found.
  * @param {String|Array} `patterns` One or more glob patterns to use for matching.
  * @param {Object} `options` See available [options](#options) for changing how matches are performed
- * @return {Boolean} Returns true if any patterns match `str`
+ * @return {Boolean} Returns true if any `patterns` matches any of the strings in `list`
  * @api public
  */
 
@@ -288,7 +288,7 @@ micromatch.some = (list, patterns, options) => {
  * @param {String|Array} `list` The string or array of strings to test.
  * @param {String|Array} `patterns` One or more glob patterns to use for matching.
  * @param {Object} `options` See available [options](#options) for changing how matches are performed
- * @return {Boolean} Returns true if any patterns match `str`
+ * @return {Boolean} Returns true if all `patterns` matches all of the strings in `list`
  * @api public
  */
 
@@ -354,7 +354,7 @@ micromatch.all = (str, patterns, options) => {
  * @param {String} `glob` Glob pattern to use for matching.
  * @param {String} `input` String to match
  * @param {Object} `options` See available [options](#options) for changing how matches are performed
- * @return {Boolean} Returns an array of captures if the input matches the glob pattern, otherwise `null`.
+ * @return {Array|null} Returns an array of captures if the input matches the glob pattern, otherwise `null`.
  * @api public
  */
 
