Skip to content

Commit 97403af

Browse files
committed
docs: Add comment and doc new variables
1 parent e0732f2 commit 97403af

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed

docs/content/Development-API/_index.en.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,23 @@ Return non-nil if the terminal supports colors.
4848
Eask's home directory path.
4949

5050
```elisp
51-
(message "%s" eask-homedir)
51+
(message "%s" eask-homedir) ; ~/.eask/
52+
```
53+
54+
## 🔍 Variable: eask-userdir
55+
56+
Eask's user directory path.
57+
58+
```elisp
59+
(message "%s" eask-userdir) ; ~/
60+
```
61+
62+
## 🔍 Variable: eask-package-sys-dir
63+
64+
Eask global elpa directory; it will be treated as the system-wide packages.
65+
66+
```elisp
67+
(message "%s" eask-package-sys-dir) ; ~/.eask/30.1/elpa/
5268
```
5369

5470
## 🔍 Variable: eask-invocation

docs/content/Development-API/_index.zh-tw.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,22 @@ Eask 的主目錄路徑。
5050
(message "%s" eask-homedir)
5151
```
5252

53+
## 🔍 Variable: eask-userdir
54+
55+
Eask 的使用者目錄路徑。
56+
57+
```elisp
58+
(message "%s" eask-userdir) ; ~/
59+
```
60+
61+
## 🔍 Variable: eask-package-sys-dir
62+
63+
Eask 全局 elpa 目錄;它將被視為系統全域的套件。
64+
65+
```elisp
66+
(message "%s" eask-package-sys-dir) ; ~/.eask/30.1/elpa/
67+
```
68+
5369
## 🔍 變數: eask-invocation
5470

5571
Eask的呼叫程式路徑。

lisp/_prepare.el

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,18 +85,18 @@ Arguments FNC and ARGS are used for advice `:around'."
8585
(defconst eask-homedir (getenv "EASK_HOMEDIR")
8686
"Eask's home directory path.
8787
88-
It points to the global home directory `/path/to/home/.eask/'.")
88+
It points to the global home directory `~/.eask/'.")
8989

9090
(defconst eask-userdir (expand-file-name "../" eask-homedir)
9191
"Eask's user directory path.
9292
93-
It points to the global user directory `/path/to/home/'.")
93+
It points to the global user directory `~/'.")
9494

9595
(defconst eask-package-sys-dir (expand-file-name (concat emacs-version "/elpa/")
9696
eask-homedir)
9797
"Eask global elpa directory; it will be treated as the system-wide packages.
9898
99-
It points to the global elpa directory `/path/to/home/.eask/XX.X/elpa/'")
99+
It points to the global elpa directory `~/.eask/XX.X/elpa/'.")
100100

101101
(defconst eask-invocation (getenv "EASK_INVOCATION")
102102
"Eask's invocation program path.")
@@ -692,7 +692,7 @@ Argument BODY are forms for execution."
692692
(declare (indent 1) (debug t))
693693
`(let ((package-archives package-archives)
694694
(archives (eask-listify ,archives))
695-
(package-user-dir eask-package-sys-dir) ; Point to the global directory.
695+
(package-user-dir eask-package-sys-dir) ; Install as global packages.
696696
(added))
697697
(dolist (archive archives)
698698
(unless (assoc archive package-archives)

0 commit comments

Comments
 (0)