ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(providence-analytics): cleanups comments

Browse source
This commit is contained in:
Thijs Louisse 2020-07-28 17:21:09 +02:00
parent 817db74531
commit 8e86e0f730
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/providence-analytics/src/program/analyzers/helpers/Analyzer.js
View file

@ -48,7 +48,7 @@ async function analyzePerAstEntry(projectData, astAnalysis) {
} }
/** /**
* @desc This method ensures that the result returned by an analyzer always has a consitent format, * @desc This method ensures that the result returned by an analyzer always has a consistent format.
* By returning the configuration for the queryOutput, it will be possible to run later queries * By returning the configuration for the queryOutput, it will be possible to run later queries
* under the same circumstances * under the same circumstances
* @param {array} queryOutput * @param {array} queryOutput

10
packages/providence-analytics/src/program/utils/async-array-utils.js
View file

@ -1,7 +1,7 @@
/** /**
* @desc Readable way to do an async forEach * @desc Readable way to do an async forEach
* Since predictability mathers, all array items will be handled in a queue; * Since predictability matters, all array items will be handled in a queue,
* one after anotoher * one after another
* @param {array} array * @param {array} array
* @param {function} callback * @param {function} callback
*/ */
@ -13,8 +13,8 @@ async function aForEach(array, callback) {
} }
/** /**
* @desc Readable way to do an async forEach * @desc Readable way to do an async forEach
* Since predictability mathers, all array items will be handled in a queue; * If predictability does not matter, this method will traverse array items concurrently,
* one after anotoher * leading to a better performance
* @param {array} array * @param {array} array
* @param {function} callback * @param {function} callback
*/ */
@ -23,7 +23,7 @@ async function aForEachNonSequential(array, callback) {
} }
/** /**
* @desc Readable way to do an async map * @desc Readable way to do an async map
* Since predictability is crucial for a map, all array items will be handled in a queue; * Since predictability is crucial for a map, all array items will be handled in a queue,
* one after anotoher * one after anotoher
* @param {array} array * @param {array} array
* @param {function} callback * @param {function} callback