From 566b9121fda2cd6a01f8458c286beb12d69bd47b Mon Sep 17 00:00:00 2001 From: Josh B <30708316+joshbax189@users.noreply.github.com> Date: Thu, 14 Nov 2024 17:13:01 +1300 Subject: [PATCH] Fix some typos in help messages and command doco (#280) * Fix typo: script not scripts * Fix typo: In used archive => Archives in use * Fix typo: install-deps --dev description * Fix typo: --allow-error option description * Fix typo: help message had 'metter' * Fix typo: eask link messages presented => present --- cmds/core/install-deps.js | 2 +- docs/content/Getting-Started/Basic-Usage/_index.en.md | 2 +- docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md | 2 +- eask | 2 +- lisp/core/archives.el | 2 +- lisp/help/link/add/success/eask | 2 +- lisp/help/link/add/success/pkg | 6 +++--- lisp/help/run/script | 6 +++--- lisp/link/add.el | 6 +++--- lisp/link/delete.el | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) mode change 100644 => 100755 eask diff --git a/cmds/core/install-deps.js b/cmds/core/install-deps.js index 00f6729e..4aebb26d 100644 --- a/cmds/core/install-deps.js +++ b/cmds/core/install-deps.js @@ -22,7 +22,7 @@ exports.desc = 'Automatically install package dependencies'; exports.builder = yargs => yargs .options({ 'development': { - description: 'install include development dependencies', + description: 'also install development dependencies', alias: 'dev', type: 'boolean', group: TITLE_CMD_OPTION, diff --git a/docs/content/Getting-Started/Basic-Usage/_index.en.md b/docs/content/Getting-Started/Basic-Usage/_index.en.md index 3f24e0ba..3fee7dfe 100644 --- a/docs/content/Getting-Started/Basic-Usage/_index.en.md +++ b/docs/content/Getting-Started/Basic-Usage/_index.en.md @@ -89,7 +89,7 @@ Options: -f, --force enable force flag [boolean] --debug turn on debug mode [boolean] --strict report error instead of warnings [boolean] - --allow-error continue the executioon even there is error reported [boolean] + --allow-error attempt to continue execution on error [boolean] --insecure allow insecure connection [boolean] --no-color enable/disable color output [boolean] -v, --verbose set verbosity from 0 to 5 [number] diff --git a/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md b/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md index 19e0a667..12303c07 100644 --- a/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md +++ b/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md @@ -86,7 +86,7 @@ Options: -f, --force enable force flag [boolean] --debug turn on debug mode [boolean] --strict report error instead of warnings [boolean] - --allow-error continue the executioon even there is error reported [boolean] + --allow-error attempt to continue execution on error [boolean] --insecure allow insecure connection [boolean] --no-color enable/disable color output [boolean] -v, --verbose set verbosity from 0 to 5 [number] diff --git a/eask b/eask old mode 100644 new mode 100755 index 0c8326e1..b2ed2bdd --- a/eask +++ b/eask @@ -61,7 +61,7 @@ yargs type: 'boolean', }, 'allow-error': { - description: `continue the executioon even there is error reported`, + description: `attempt to continue execution on error`, type: 'boolean', }, 'insecure': { diff --git a/lisp/core/archives.el b/lisp/core/archives.el index 05ab4827..43db7ebb 100644 --- a/lisp/core/archives.el +++ b/lisp/core/archives.el @@ -48,7 +48,7 @@ (eask-info "(Total of %s archive%s available)" (length eask-source-mapping) (eask--sinr eask-source-mapping "" "s"))) (package-archives - (eask-info "In used archives:") + (eask-info "Archives in use:") (eask-msg "") (eask-archive--print-alist package-archives) (eask-info "(Total of %s archive%s listed)" (length package-archives) diff --git a/lisp/help/link/add/success/eask b/lisp/help/link/add/success/eask index ba1a9c76..67387388 100644 --- a/lisp/help/link/add/success/eask +++ b/lisp/help/link/add/success/eask @@ -1,7 +1,7 @@ ✓ You have now created the link, here are things you might want to consider: - - [ ] (Optional) Compile source package with `.elc` files Use `.elc` may be metter choice + - [ ] (Optional) Compile source package with `.elc` files If the source package uses Eask, you can use `eask` commands to accomplish these tasks. diff --git a/lisp/help/link/add/success/pkg b/lisp/help/link/add/success/pkg index b21a2588..a0e77742 100644 --- a/lisp/help/link/add/success/pkg +++ b/lisp/help/link/add/success/pkg @@ -1,10 +1,10 @@ ✓ You have now created the link, here are things you might want to consider: - + - [ ] (Optional) `SOURCE-autoloads.el` Package autoloads - - [ ] (Optional) Compile source package with `.elc` files Use `.elc` may be metter choice + - [ ] (Optional) Compile source package with `.elc` files If the source package uses Eask, you can use `eask` commands to accomplish these tasks. - + * `eask generate autoloads` * `eask compile` diff --git a/lisp/help/run/script b/lisp/help/run/script index b3bf7d2b..b5de609f 100644 --- a/lisp/help/run/script +++ b/lisp/help/run/script @@ -1,4 +1,4 @@ -💡 Make sure you have specify a (scripts ..) directive inside your Eask file! - - [+] (scripts "test" "echo This is a test command!") +💡 Make sure you have a (script ..) directive inside your Eask file! + + [+] (script "test" "echo This is a test command!") diff --git a/lisp/link/add.el b/lisp/link/add.el index a29b8e47..a8c589af 100644 --- a/lisp/link/add.el +++ b/lisp/link/add.el @@ -39,7 +39,7 @@ (when (file-exists-p link-path) (eask-msg "") (eask-with-progress - (ansi-yellow "!! The link is already presented; override the existing link... ") + (ansi-yellow "!! The link is already present; overriding the existing link... ") (eask-link-delete-symlink link-path) (ansi-yellow "done !!"))) (make-symbolic-link source link-path) @@ -104,12 +104,12 @@ (format " - [1/2] Generating %s file... " autoloads-file) (unless autoloads-file-presented (eask-with-verbosity 'debug (eask-call "generate/autoloads"))) - (if autoloads-file-presented "already presented ✗" "done ✓")) + (if autoloads-file-presented "already present ✗" "done ✓")) (eask-with-progress (format " - [2/2] Generating %s file... " pkg-file) (unless pkg-file-presented (eask-with-verbosity 'debug (eask-call "generate/pkg-file"))) - (if pkg-file-presented "already presented ✗" "done ✓"))) + (if pkg-file-presented "already present ✗" "done ✓"))) (eask-link-add--create source) (when (and (zerop (length links)) ; if no link previously, (= 1 (length (eask-link-list)))) ; and first link created! diff --git a/lisp/link/delete.el b/lisp/link/delete.el index 3036c03a..55106a97 100644 --- a/lisp/link/delete.el +++ b/lisp/link/delete.el @@ -51,7 +51,7 @@ (eask-help "link/delete")) ;; No link to delete ((zerop (length links)) - (eask-info "No links presented; tasks ended with no operation")) + (eask-info "No links present; task ended with no operation")) ;; Link not found ((cl-some (lambda (name) (not (member name link-names)))