Added more detailed param info to actions.js #486
Conversation
| @@ -357,8 +357,10 @@ actions.directory = function directory(source, destination, process) { | |||
| /** | |||
| * Copies recursively the files from source directory to root directory. | |||
| * | |||
| * @param {String} source | |||
| * @param {String} destination | |||
| * An optimized copy method for larger file trees. See this.bulkCopy. | |||
There was a problem hiding this comment.
An "optimized copy method" is not really the words to use. It is not optimized, it strip operations to allow copying large files tree. You should never use this method, unless there's no other solutions. I think this warning should be there (on both bulk methods).
|
Can you align description together, e.g.: |
|
Hey @AshKyd will you be able to take care of it? |
|
Yep, for sure. I'll have another go over the weekend. |
|
Hi @SBoudrias, thanks for bearing with me. I've made these changes. I've renamed bulkCopy to “a simplified copy method” and added your warning. I'm still not sure that's right though, do you have any preference on wording? |
| @@ -124,11 +124,12 @@ actions.copy = function copy(source, destination, process) { | |||
| * https://github.com/yeoman/generator/pull/359 | |||
| * https://github.com/yeoman/generator/issues/350 | |||
| * | |||
| * An optimized copy method for larger file trees. Does not do | |||
| * A simplified copy method for larger file trees. Does not do | |||
There was a problem hiding this comment.
Try something like: "A copy method skiping templating and conflict checking. It will allow copying a large amount of files without causing too much recursion errors. You should never use this method, unless there's no other solutions."
|
Hey, see my last comment and squash your commits into a single one. Then we'll be good to merge. Thanks a lot! |
|
Done. |
|
Thanks a lot, feel free to continue helping if there's other malformatted sections! |
Added more detailed param info to actions.js
Updated the jsdoc in actions.js to make the operation of params on various functions clearer. Let me know if there's anything you think could be clearer.