unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Federico Tedin <federicotedin@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 25496@debbugs.gnu.org, Noam Postavsky <npostavs@gmail.com>
Subject: bug#25496: 25.1.91; INSIDE_EMACS env variable is not set in eshell
Date: Sat, 04 Apr 2020 12:08:43 +0200	[thread overview]
Message-ID: <87ftdjo95g.fsf@gmail.com> (raw)
In-Reply-To: <83k12wwyp1.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 03 Apr 2020 15:17:30 +0300")

[-- Attachment #1: Type: text/plain, Size: 500 bytes --]

>> I'll wait a couple of days (in case there are any more suggested
>> changes) and then push to master.
>
> Done.

Thanks!

> Would it be possible to reword this so that passive tense is used less
> frequently?  E.g., instead of "the variable with that name in the
> current environment will be returned", how about "return the variable
> with that name in the current environment"?  And similarly with the
> rest of the doc string.
>
> Thanks.

No problem, I've attached a patch with the changes.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Reword-documentation-for-eshell-variable-aliases-lis.patch --]
[-- Type: text/x-diff, Size: 2690 bytes --]

From 1e77ef50a7bf24e67fa6003bb768cdae2202a270 Mon Sep 17 00:00:00 2001
From: Federico Tedin <federicotedin@gmail.com>
Date: Sat, 4 Apr 2020 12:04:11 +0200
Subject: [PATCH] Reword documentation for eshell-variable-aliases-list

* lisp/eshell/esh-var.el (eshell-variable-aliases-list): Update
documentation string.
---
 lisp/eshell/esh-var.el | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el
index 3093abd830..70516b3b82 100644
--- a/lisp/eshell/esh-var.el
+++ b/lisp/eshell/esh-var.el
@@ -183,24 +183,24 @@ eshell-variable-aliases-list
 compute the string value that will be returned when the variable is
 accessed via the syntax `$NAME'.
 
-If the value is a function, that function will be called with two
-arguments: the list of the indices that was used in the reference, and
-whether the user is requesting the length of the ultimate element.
-For example, a reference of `$NAME[10][20]' would result in the
-function for alias `NAME' being called (assuming it were aliased to a
-function), and the arguments passed to this function would be the list
-'(10 20)', and nil.
-
-If the value is a string, the value for the variable with that name in
-the current environment will be returned.  If no variable with that
-name exists in the environment, but if a symbol with that same name
-exists and has a value bound to it, then that value will be used.  You
-can prioritize symbol values over environment values by setting
+If the value is a function, call that function with two arguments: the
+list of the indices that was used in the reference, and whether the
+user is requesting the length of the ultimate element.  For example, a
+reference of `$NAME[10][20]' would result in the function for alias
+`NAME' being called (assuming it were aliased to a function), and the
+arguments passed to this function would be the list '(10 20)', and
+nil.
+
+If the value is a string, return the value for the variable with that
+name in the current environment.  If no variable with that name exists
+in the environment, but if a symbol with that same name exists and has
+a value bound to it, return its value instead.  You can prioritize
+symbol values over environment values by setting
 `eshell-prefer-lisp-variables' to t.
 
-If the value is a symbol, the value bound to that symbol will be used.
+If the value is a symbol, return the value bound to it.
 
-If the value has any other type, `error' will be signaled.
+If the value has any other type, signal `error'.
 
 Additionally, each member may specify if it should be copied to the
 environment of created subprocesses."
-- 
2.17.1


  reply	other threads:[~2020-04-04 10:08 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-20 22:32 bug#25496: 25.1.91; INSIDE_EMACS env variable is not set in eshell Alex Hutcheson
2017-01-23 20:20 ` Glenn Morris
2017-01-23 20:36   ` Alex Hutcheson
2020-03-08 16:50 ` Federico Tedin
2020-03-28 15:05   ` Federico Tedin
2020-03-29  0:21   ` Noam Postavsky
2020-03-29 22:29     ` Federico Tedin
2020-03-30  1:44       ` Noam Postavsky
2020-03-30 19:52         ` Federico Tedin
2020-03-30 23:11           ` Noam Postavsky
2020-04-02 23:06             ` Noam Postavsky
2020-04-03 12:17             ` Eli Zaretskii
2020-04-04 10:08               ` Federico Tedin [this message]
2020-04-11  9:20                 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87ftdjo95g.fsf@gmail.com \
    --to=federicotedin@gmail.com \
    --cc=25496@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=npostavs@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).