jsdoc-style documentation for 'collection' methods

Converted documentation from README to jsdoc-style for respective
methods. Currently, only done for 'collection' methods.

jsdoc-style documentation - fixed 'collection' methods documentation

Only the base functions now contain an example, while the `series` and
`limit` versions simply contain a reference to the base function. Fixed
styling issue and misspelled tag.

1 files changed, 29 insertions, 0 deletions

diff --git a/lib/some.js b/lib/some.js
index 000f2e2..ccae178 100644
--- a/lib/some.js
+++ b/lib/some.js
@@ -3,4 +3,33 @@
 import someLimit from './someLimit';
 import doLimit from './internal/doLimit';
 
+/**
+ * Returns `true` if at least one element in the `coll` satisfies an async test.
+ * If any iteratee call returns `true`, the main `callback` is immediately
+ * called.
+ *
+ * @name some
+ * @static
+ * @memberOf async
+ * @alias any
+ * @category Collection
+ * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Function} iteratee - A truth test to apply to each item in the array
+ * in parallel. The iteratee is passed a `callback(err, truthValue)` which must
+ * be called with a boolean argument once it has completed. Invoked with
+ * (item, callback).
+ * @param {Function} [callback] - A callback which is called as soon as any
+ * iteratee returns `true`, or after all the iteratee functions have finished.
+ * Result will be either `true` or `false` depending on the values of the async
+ * tests. Invoked with (err, result).
+ * @example
+ *
+ * async.some(['file1','file2','file3'], function(filePath, callback) {
+ *     fs.access(filePath, function(err) {
+ *         callback(null, !err)
+ *     });
+ * }, function(err, result) {
+ *     // if result is true then at least one of the files exists
+ * });
+ */
 export default doLimit(someLimit, Infinity);