From fe3cff78adadcaa5443954fe20f913612bdd1a82 Mon Sep 17 00:00:00 2001 From: Maroxy Date: Tue, 21 Dec 2021 22:45:01 +0100 Subject: [PATCH] Fix Comments and provide proper english --- src/ts/AbstractInstaller.ts | 12 ++++++------ src/ts/Archive.ts | 8 ++++---- src/ts/Configs.ts | 8 ++++---- src/ts/DXVK.ts | 6 +++--- src/ts/Downloader.ts | 6 +++--- src/ts/Runners.ts | 6 +++--- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/ts/AbstractInstaller.ts b/src/ts/AbstractInstaller.ts index d09d507..d163563 100644 --- a/src/ts/AbstractInstaller.ts +++ b/src/ts/AbstractInstaller.ts @@ -92,7 +92,7 @@ export default abstract class Installer } /** - * Specify event that will be called after downloading will begin + * Specify event that will be called after download has begun * * @param callback */ @@ -105,7 +105,7 @@ export default abstract class Installer } /** - * Specify event that will be called after unpacking will begin + * Specify event that will be called after extraction has begun * * @param callback */ @@ -118,7 +118,7 @@ export default abstract class Installer } /** - * Specify event that will be called every [this.downloadProgressInterval] ms during downloading + * Specify event that will be called every [this.downloadProgressInterval] ms while downloading * * @param callback */ @@ -128,7 +128,7 @@ export default abstract class Installer } /** - * Specify event that will be called every [this.unpackProgressInterval] ms during unpacking + * Specify event that will be called every [this.unpackProgressInterval] ms while extracting * * @param callback */ @@ -138,7 +138,7 @@ export default abstract class Installer } /** - * Specify event that will be called after downloading will be finished + * Specify event that will be called after download has finished * * @param callback */ @@ -151,7 +151,7 @@ export default abstract class Installer } /** - * Specify event that will be called after unpacking will be finished + * Specify event that will be called after extraction has finished * * @param callback */ diff --git a/src/ts/Archive.ts b/src/ts/Archive.ts index cd5348f..50c43f3 100644 --- a/src/ts/Archive.ts +++ b/src/ts/Archive.ts @@ -109,7 +109,7 @@ class Stream } /** - * Specify event that will be called when the unpacking will be started + * Specify event that will be called when the extraction has started * * @param callback */ @@ -122,7 +122,7 @@ class Stream } /** - * Specify event that will be called every [this.progressInterval] ms during archive unpacking + * Specify event that will be called every [this.progressInterval] ms while extracting the archive * * @param callback */ @@ -132,7 +132,7 @@ class Stream } /** - * Specify event that will be called after the archive will be unpacked + * Specify event that will be called after the archive has been extracted * * @param callback */ @@ -145,7 +145,7 @@ class Stream } /** - * Specify event that will be called if archive can't be unpacked + * Specify event that will be called if archive can't be extracted * * @param callback */ diff --git a/src/ts/Configs.ts b/src/ts/Configs.ts index 75f1580..9a93d4d 100644 --- a/src/ts/Configs.ts +++ b/src/ts/Configs.ts @@ -13,7 +13,7 @@ export default class Configs * Get config value * * @param name config name, e.g. "lang.launcher" - * @returns undefined if config is not exists. Otherwise - config value + * @returns undefined if config doesn't exist. Otherwise - config value */ public static get(name: string = ''): Promise { @@ -38,7 +38,7 @@ export default class Configs * * @param name config name, e.g. "lang.launcher" * @param value config value, e.g. "en-us" - * @returns Promise indicates when the settings was updated + * @returns Promise indicates if the settings were updated */ public static set(name: string, value: scalar|scalar[]): Promise { @@ -68,7 +68,7 @@ export default class Configs * Set default values * * @param configs object of default values - * @returns Promise indicates when the default settings was applied + * @returns Promise indicates if the default settings were applied */ public static defaults(configs: scalar): Promise { @@ -76,7 +76,7 @@ export default class Configs const setDefaults = async (current: scalar) => { const updateDefaults = (current: scalar, defaults: scalar) => { Object.keys(defaults).forEach((key) => { - // If the field exists in defaults and don't exists in current + // If the field exists in defaults and doesn't exist in current if (current[key] === undefined) current[key] = defaults[key]; diff --git a/src/ts/DXVK.ts b/src/ts/DXVK.ts index f85f5b9..2657f42 100644 --- a/src/ts/DXVK.ts +++ b/src/ts/DXVK.ts @@ -50,13 +50,13 @@ export default class DXVK * Download DXVK to the [Constants.paths.dxvks] directory * * @param dxvk DXVK object or version - * @returns null if the DXVK with specified version is not exists. Otherwise - installation stream + * @returns null if the DXVK with specified version dosen't exist. Otherwise - installation stream */ public static download(dxvk: TDXVK|TDXVK['version']): Promise { return new Promise(async (resolve) => { - // If we provided dxvk property as a version of the DXVK - // then we should find this DXVK and call this method from it + // If we provided dxvk parameter with a version of DXVK + // then we should find this DXVK version and call this method for it if (typeof dxvk == 'string') { let foundDXVK = null; diff --git a/src/ts/Downloader.ts b/src/ts/Downloader.ts index 8ed816a..cdd563d 100644 --- a/src/ts/Downloader.ts +++ b/src/ts/Downloader.ts @@ -59,7 +59,7 @@ class Stream } /** - * Specify event that will be called when the downloading will be started + * Specify event that will be called when the download gets started * * @param callback */ @@ -72,7 +72,7 @@ class Stream } /** - * Specify event that will be called every [this.progressInterval] ms during the file downloading + * Specify event that will be called every [this.progressInterval] ms while the file is downloading * * @param callback */ @@ -82,7 +82,7 @@ class Stream } /** - * Specify event that will be called after the file will be downloaded + * Specify event that will be called after the file is downloaded * * @param callback */ diff --git a/src/ts/Runners.ts b/src/ts/Runners.ts index 39f343b..6f93c2d 100644 --- a/src/ts/Runners.ts +++ b/src/ts/Runners.ts @@ -62,13 +62,13 @@ class Runners * Download runner to the [Constants.paths.runners] directory * * @param runner runner object or name - * @returns null if the runner with specified name is not exists. Otherwise - installation stream + * @returns null if the runner with specified name dosen't exist. Otherwise - installation stream */ public static download(runner: Runner|Runner['name']): Promise { return new Promise(async (resolve) => { - // If we provided runner property as a name of the runner - // then we should find this runner and call this method from it + // If we provided runner parameter with a name of a runner + // then we should find this runner and call this method for it if (typeof runner == 'string') { let foundRunner = null;