docs(spelling): Add codespell config + github action, run and fix a good number of typos (#3645)

This commit is contained in:
Yaroslav Halchenko authored and GitHub committed 2023-09-12 07:40:38 -04:00
1 parent 64079e0720
commit 11ca5b6eae
76 files changed
+128 -100

No files matched your search

+1 -1
View File
@@ -8,7 +8,7 @@ export default class Queue {
/**
* Creates a new "proxy" function associated with the current execution queue
* instance. When the returned function is invoked, the queue limit is checked
* to make sure the limit of scheduled tasks is repected (throwing an
* to make sure the limit of scheduled tasks is respected (throwing an
* exception when the limit has been reached and before calling the original
* function). The original function is only invoked after all the previously
* scheduled tasks have finished executing (their returned promises have
@@ -36,11 +36,11 @@ function addToList(list, ...values) {
* once for each leaf-node of the tree. The ancestors of the leaf-node being
* visited are passed to the callback function along with the leaf-node in
* the exact same order they appear on the tree (from root to leaf);
* @ For example, if the hierachy `a > b > c` appears on the tree ("a" being
* @ For example, if the hierarchy `a > b > c` appears on the tree ("a" being
* the root and "c" being the leaf) the callback function will be called as:
* callback('a', 'b', 'c');
* @param {Array} list The hierarchical list to be iterated
* @param {function} callback The callback which will be exected once for
* @param {function} callback The callback which will be executed once for
* each leaf-node of the hierarchical list;
* @returns {Array} Returns the provided list or null for bad arguments;
*/
+1 -1
View File
@@ -6,7 +6,7 @@ export class ObjectPath {
* @param path {String} A string representing the property to be set, e.g. "user.study.series.timepoint".
* @param value {Any} The value of the property that will be set.
* @return {Boolean} Returns "true" on success, "false" if any intermediate component of the supplied path
* ... is not a valid Object, in which case the property cannot be set. No excpetions are thrown.
* ... is not a valid Object, in which case the property cannot be set. No exceptions are thrown.
*/
static set(object, path, value) {
let components = ObjectPath.getPathComponents(path),
@@ -114,7 +114,7 @@ function finish(task) {
/**
* Generate a summarized snapshot of the current status of the given task List
* @param {Object} list The List instance to be scanned
* @returns {Object} An obeject representing the summarized status of the list
* @returns {Object} An object representing the summarized status of the list
*/
function getOverallProgress(list) {
const status = createStatus();
@@ -223,7 +223,7 @@ function getTaskByName(list, name) {
* @param {Object} list The List instance to which the observer will be appended
* @param {Function} observer The observer (function) that will be executed
* every time a change happens within the list
* @returns {boolean} Returns true on success and false otherewise
* @returns {boolean} Returns true on success and false otherwise
*/
function addObserver(list, observer) {
if (isList(list) && Array.isArray(list.observers) && typeof observer === 'function') {
@@ -237,7 +237,7 @@ function addObserver(list, observer) {
* Removes an observer (callback function) from a given List instance
* @param {Object} list The instance List from which the observer will removed
* @param {Function} observer The observer function to be removed
* @returns {boolean} Returns true on success and false otherewise
* @returns {boolean} Returns true on success and false otherwise
*/
function removeObserver(list, observer) {
if (isList(list) && Array.isArray(list.observers) && list.observers.length > 0) {
+1 -1
View File
@@ -1,4 +1,4 @@
/** Splits a list of stirngs by commas within the strings */
/** Splits a list of strings by commas within the strings */
const splitComma = (strings: string[]): string[] => {
if (!strings) {
return null;