Skip to content

Commit 5440448

Browse files
jcs090218jcs090218
committed
docs: Improve command descriptions
1 parent 9da21f9 commit 5440448

File tree

5 files changed

+53
-37
lines changed

5 files changed

+53
-37
lines changed

‎cmds/util/locate.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"use strict";
1919

2020
exports.command = ['locate'];
21-
exports.desc = 'Print out Eask installed location';
21+
exports.desc = 'Show the location where Eask is installed';
2222

2323
exports.handler = async (argv) => {
2424
process.stdout.write(`✓ Eask located in '` + UTIL.plugin_dir() + `'`);

‎docs/content/Getting-Started/Basic-Usage/_index.en.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,28 +50,28 @@ Commands:
5050
init [files..] Initialize project to use Eask
5151
install-deps Automatically install package dependencies [aliases: install-dependencies, prepare]
5252
install-file [files..] Install packages from files, .tar files, or directories
53-
install-vc [specs..] Install packages directly from the version control
54-
install [names..] Install packages
55-
keywords List available keywords that can be used in the header section
53+
install-vc [specs..] Fetch and install packages directly via version control
54+
install [names..] Install packages from archives or install from the workspace
55+
keywords Display the available keywords for use in the header section
5656
link <action> Manage links
5757
lint <type> Run linters
5858
list List packages
5959
load-path [patterns..] Print the load-path from workspace
6060
load [files..] Load elisp files
6161
outdated Show all outdated dependencies
62-
package-directory Print path to package directory
62+
package-directory Print the path to package directory
6363
package [destination] Build a package artifact, and put it into the given destination [aliases: pack]
6464
recipe Suggest a recipe format
6565
recompile [names..] Byte-recompile `.el' files
66-
refresh Download package archives
67-
reinstall [names..] Reinstall packages
66+
refresh Download descriptions of all configured package archives
67+
reinstall [names..] Reinstall packages from archives
6868
run <type> Run custom tasks
69-
search [queries..] Search packages
70-
status Display the state of the workspace
69+
search [queries..] Search packages from archives
70+
status Show the workspace status
7171
test <type> Run regression/unit tests
72-
uninstall [names..] Uninstall packages [aliases: delete]
73-
upgrade [names..] Upgrade packages
74-
locate Print out Eask installed location
72+
uninstall [names..] Uninstall packages from archives [aliases: delete]
73+
upgrade [names..] Upgrade packages from archives
74+
locate Show the location where Eask is installed
7575
upgrade-eask Upgrade Eask itself [aliases: upgrade-self]
7676
7777
Proxy Options:

‎docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,28 +47,28 @@ Commands:
4747
init [files..] Initialize project to use Eask
4848
install-deps Automatically install package dependencies [aliases: install-dependencies, prepare]
4949
install-file [files..] Install packages from files, .tar files, or directories
50-
install-vc [specs..] Install packages directly from the version control
51-
install [names..] Install packages
52-
keywords List available keywords that can be used in the header section
50+
install-vc [specs..] Fetch and install packages directly via version control
51+
install [names..] Install packages from archives or install from the workspace
52+
keywords Display the available keywords for use in the header section
5353
link <action> Manage links
5454
lint <type> Run linters
5555
list List packages
5656
load-path [patterns..] Print the load-path from workspace
5757
load [files..] Load elisp files
5858
outdated Show all outdated dependencies
59-
package-directory Print path to package directory
59+
package-directory Print the path to package directory
6060
package [destination] Build a package artifact, and put it into the given destination [aliases: pack]
6161
recipe Suggest a recipe format
6262
recompile [names..] Byte-recompile `.el' files
63-
refresh Download package archives
64-
reinstall [names..] Reinstall packages
63+
refresh Download descriptions of all configured package archives
64+
reinstall [names..] Reinstall packages from archives
6565
run <type> Run custom tasks
66-
search [queries..] Search packages
67-
status Display the state of the workspace
66+
search [queries..] Search packages from archives
67+
status Show the workspace status
6868
test <type> Run regression/unit tests
69-
uninstall [names..] Uninstall packages [aliases: delete]
70-
upgrade [names..] Upgrade packages
71-
locate Print out Eask installed location
69+
uninstall [names..] Uninstall packages from archives [aliases: delete]
70+
upgrade [names..] Upgrade packages from archives
71+
locate Show the location where Eask is installed
7272
upgrade-eask Upgrade Eask itself [aliases: upgrade-self]
7373
7474
Proxy Options:

‎docs/content/Getting-Started/Commands-and-options/_index.en.md‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,15 @@ eask [GLOBAL-OPTIONS] info
108108

109109
## 🔍 eask status
110110

111-
Display the state of the workspace.
111+
Show the workspace status.
112112

113113
```sh
114114
eask [GLOBAL-OPTIONS] status
115115
```
116116

117117
## 🔍 eask install
118118

119-
To install packages.
119+
To install packages from archives or install from the workspace.
120120

121121
```sh
122122
eask [GLOBAL-OPTIONS] install [PACKAGES..]
@@ -158,7 +158,7 @@ eask [GLOBAL-OPTIONS] install-file [FILES..]
158158

159159
## 🔍 eask install-vc
160160

161-
Install packages directly from the version control.
161+
Fetch and install packages directly via version control.
162162

163163
```sh
164164
eask [GLOBAL-OPTIONS] install-vc [SPECS..]
@@ -178,12 +178,20 @@ Uninstall packages by specifying arguments:
178178
eask uninstall dash f s
179179
```
180180

181-
Or else, it will uninstall the package from the current development:
181+
Or else, it will uninstall the package from the current workspace:
182182

183183
```sh
184184
eask uninstall
185185
```
186186

187+
## 🔍 eask reinstall
188+
189+
To reinstall packages from archives.
190+
191+
```sh
192+
eask [GLOBAL-OPTIONS] reinstall [PACKAGES..]
193+
```
194+
187195
## 🔍 eask package
188196

189197
Build the package artifact.
@@ -232,7 +240,7 @@ compiling.
232240

233241
## 🔍 eask package-directory
234242

235-
Print path to package directory, where all dependencies are installed.
243+
Print the path to package directory, where all dependencies are installed.
236244

237245
```sh
238246
eask [GLOBAL-OPTIONS] package-directory
@@ -280,7 +288,7 @@ eask [GLOBAL-OPTIONS] recipe [FILES..]
280288

281289
## 🔍 eask keywords
282290

283-
List available keywords that can be used in the header section.
291+
Display the available keywords for use in the header section.
284292

285293
```sh
286294
eask [GLOBAL-OPTIONS] keywords
@@ -381,7 +389,7 @@ eask [GLOBAL-OPTIONS] eval [FORM]
381389

382390
## 🔍 eask repl
383391

384-
Start the Elisp REPL.
392+
Start an Elisp REPL.
385393

386394
```sh
387395
eask [GLOBAL-OPTIONS] repl [FILES..]
@@ -446,7 +454,7 @@ eask [GLOBAL-OPTIONS] search [QUEIRES..]
446454

447455
## 🔍 eask upgrade
448456

449-
Upgrade all packages.
457+
Upgrade all packages from archives.
450458

451459
```sh
452460
eask [GLOBAL-OPTIONS] upgrade
@@ -470,7 +478,7 @@ eask [GLOBAL-OPTIONS] outdated [--depth]
470478

471479
## 🔍 eask refresh
472480

473-
Download package archives.
481+
Download descriptions of all configured package archives.
474482

475483
```sh
476484
eask [GLOBAL-OPTIONS] refresh

‎docs/content/Getting-Started/Commands-and-options/_index.zh-tw.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,15 @@ eask [GLOBAL-OPTIONS] info
106106

107107
## 🔍 eask status
108108

109-
顯示工作區的狀態。
109+
顯示現在 workspace 的狀態。
110110

111111
```sh
112112
eask [GLOBAL-OPTIONS] status
113113
```
114114

115115
## 🔍 eask install
116116

117-
安裝軟件包。
117+
從包源或 workspace 安裝包。
118118

119119
```sh
120120
eask [GLOBAL-OPTIONS] install [PACKAGES..]
@@ -156,7 +156,7 @@ eask [GLOBAL-OPTIONS] install-file [FILES..]
156156

157157
## 🔍 eask install-vc
158158

159-
直接從版本控制安裝套件。
159+
直接透過版本控制擷取及安裝套件。
160160

161161
```sh
162162
eask [GLOBAL-OPTIONS] install-vc [SPECS..]
@@ -182,6 +182,14 @@ eask uninstall dash f s
182182
eask uninstall
183183
```
184184

185+
## 🔍 eask reinstall
186+
187+
重新安裝包.
188+
189+
```sh
190+
eask [GLOBAL-OPTIONS] reinstall [PACKAGES..]
191+
```
192+
185193
## 🔍 eask package
186194

187195
構建包工件。
@@ -276,7 +284,7 @@ eask [GLOBAL-OPTIONS] recipe [FILES..]
276284

277285
## 🔍 eask keywords
278286

279-
列出可在標題部分中使用的可用關鍵字。
287+
顯示可在標頭部分使用的關鍵字。
280288

281289
```sh
282290
eask [GLOBAL-OPTIONS] keywords
@@ -376,7 +384,7 @@ eask [GLOBAL-OPTIONS] eval [FORM]
376384

377385
## 🔍 eask repl
378386

379-
啟動 Elisp REPL。
387+
啟動一個 Elisp REPL。
380388

381389
```sh
382390
eask [GLOBAL-OPTIONS] repl [FILES..]

0 commit comments

Comments
 (0)