aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFederico Tedin2020-04-04 12:04:11 +0200
committerEli Zaretskii2020-04-11 12:19:50 +0300
commit3275b01487826be66d4b6e2fb550549b61bb4bf7 (patch)
tree0dd6f87e9526623ceb41eb6f620d9cfb1c070934
parentaa072db86b6b06b54d7f5846231bdf4a73b0cd84 (diff)
downloademacs-3275b01487826be66d4b6e2fb550549b61bb4bf7.tar.gz
emacs-3275b01487826be66d4b6e2fb550549b61bb4bf7.zip
Reword documentation for eshell-variable-aliases-list
* lisp/eshell/esh-var.el (eshell-variable-aliases-list): Update documentation string to avoid passive tense.
-rw-r--r--lisp/eshell/esh-var.el30
1 files changed, 15 insertions, 15 deletions
diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el
index 3093abd8304..70516b3b82f 100644
--- a/lisp/eshell/esh-var.el
+++ b/lisp/eshell/esh-var.el
@@ -183,24 +183,24 @@ Each member defines the name of a variable, and a Lisp value used to
183compute the string value that will be returned when the variable is 183compute the string value that will be returned when the variable is
184accessed via the syntax `$NAME'. 184accessed via the syntax `$NAME'.
185 185
186If the value is a function, that function will be called with two 186If the value is a function, call that function with two arguments: the
187arguments: the list of the indices that was used in the reference, and 187list of the indices that was used in the reference, and whether the
188whether the user is requesting the length of the ultimate element. 188user is requesting the length of the ultimate element. For example, a
189For example, a reference of `$NAME[10][20]' would result in the 189reference of `$NAME[10][20]' would result in the function for alias
190function for alias `NAME' being called (assuming it were aliased to a 190`NAME' being called (assuming it were aliased to a function), and the
191function), and the arguments passed to this function would be the list 191arguments passed to this function would be the list '(10 20)', and
192'(10 20)', and nil. 192nil.
193 193
194If the value is a string, the value for the variable with that name in 194If the value is a string, return the value for the variable with that
195the current environment will be returned. If no variable with that 195name in the current environment. If no variable with that name exists
196name exists in the environment, but if a symbol with that same name 196in the environment, but if a symbol with that same name exists and has
197exists and has a value bound to it, then that value will be used. You 197a value bound to it, return its value instead. You can prioritize
198can prioritize symbol values over environment values by setting 198symbol values over environment values by setting
199`eshell-prefer-lisp-variables' to t. 199`eshell-prefer-lisp-variables' to t.
200 200
201If the value is a symbol, the value bound to that symbol will be used. 201If the value is a symbol, return the value bound to it.
202 202
203If the value has any other type, `error' will be signaled. 203If the value has any other type, signal `error'.
204 204
205Additionally, each member may specify if it should be copied to the 205Additionally, each member may specify if it should be copied to the
206environment of created subprocesses." 206environment of created subprocesses."