jsdoc-style documentation for 'collection' methods #1090
Conversation
Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods.
|
That is a lot of progress! I'll review where you're at tomorrow night. Thanks! |
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.
|
@megawac I fixed the issues brought up, and I also added the |
| * @static | ||
| * @memberof async | ||
| * @memberOf async | ||
| * @see async.concat |
There was a problem hiding this comment.
Thoughts on using @see over lodashs method. In lodash docs as I understand, anything in code tags with the same @memberof tag automagically links to that method.
So it would be something like
see
async.concat
I'm fine with either approach, lodash's just seems a bit more flexible when multiple methods are linked
/cc @aearly @jdalton
There was a problem hiding this comment.
I updated it to use code tags.
/master' # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
remaining `Control Flow` methods to document: - queue - priorityQueue - cargo - auto - autoInject - retry - retryable - iterator - times, timesSeries, timesLimit - race
remaining `Util` methods to document (10): - ensureAsync - constant - asyncify - wrapSync - log - dir - noConflict - timeout - reflect - reflectAll
need to rebase to master before I can document the recently added reflect functions
documented the new `reflect` and `reflectAll` functions
|
Note: currently, I only have the |
this should be the last of the public methods requiring documentaiton
added module documentation to index.js and documentated missed method setImmediate (copied from nextTick).
|
@megawac this branch should be ready to merge, all of the methods are documented, except for |
|
Amazing. I'll review over lunch! (And i'll work on generating docs over the coming weekend) Thanks so much @hargasinski. Also |
|
Also, don't worry about squashing your commits. I'll mange it when I merge |
|
Thanks for the quick reply! It should be ready to merge, I rebased and resolved the On Tue, Apr 12, 2016 at 8:32 AM, Graeme Yeates notifications@github.com
|
| /** | ||
| * Determines the best order for running the functions in `tasks`, based on | ||
| * their requirements. Each function can optionally depend on other functions | ||
| *nbeing completed first, and each function is run as soon as its requirements |
There was a problem hiding this comment.
little typo artificat here
| * @category Util | ||
| * @param {Function} function - The function you want to eventually apply all | ||
| * arguments to. Invokes with (arguments...). | ||
| * @param {...*} arguments... - Any number of arguments to automatically apply |
There was a problem hiding this comment.
There was a problem hiding this comment.
That's how I do it.
You can try hacking around the issue with things like {...(*)} or {(...*)} or smth.
There was a problem hiding this comment.
You can try hacking around the issue with things like {...(*)} or smth.
|
Merged in 982674c...6ed90c6 (for some reason the commit messages are showing up wrong in the compare view. See https://github.com/caolan/async/commits/master) |
Converted documentation from README to jsdoc-style for respective methods. Currently, only done for 'collection' methods.
This is currently not ready to be merged, I have a couple of questions I posted in the discussion for #1083.