From: Eli Zaretskii <eliz@gnu.org>
To: Richard Stallman <rms@gnu.org>
Cc: Jim Porter <jporterbugs@gmail.com>, 66756@debbugs.gnu.org
Subject: bug#66756: 30.0.50; [PATCH] Improve discussion of 'let' in Elisp Introduction manual
Date: Sat, 04 Nov 2023 10:27:51 +0200 [thread overview]
Message-ID: <83fs1l6hyw.fsf@gnu.org> (raw)
In-Reply-To: <a5120e2f-b008-1b74-1ad9-3fe7d861b13c@gmail.com> (message from Jim Porter on Thu, 26 Oct 2023 11:30:46 -0700)
> Date: Thu, 26 Oct 2023 11:30:46 -0700
> From: Jim Porter <jporterbugs@gmail.com>
>
> On 10/26/2023 12:09 AM, Eli Zaretskii wrote:
> > Thanks.
> >
> > The challenge in updating the Lisp Introduction manual is to try to
> > keep its informal and reader-friendly style as much as possible. It
> > is not just another ELisp Reference manual! So please try to keep
> > that in mind when you write the text, and in particular try not to
> > modify the existing text that is still accurate -- it was written by a
> > master, and each word there counts, even if it looks at first sight as
> > not important.
>
> Ok, here's a second attempt. I've tried to avoid changing anything that
> I don't think is truly necessary. I did alter a bit of the original
> wording to emphasize that under lexical binding, 'let' isn't about time,
> but about place. For example, that's why I changed this:
>
> > This is like understanding that whenever your host refers to ``the house'', he means his house, not yours.
>
> to this:
>
> > This is like understanding that in your host's home, whenever he refers to ``the house'', he means his house, not yours.
>
> My previous concern about the "lexical binding" digression still applies
> though. However, I'm not sure how to get around that at present; if we
> want to talk about lexical binding in the manual, we need to get users
> to enable it, so I think it's unavoidable that we at least mention it. I
> tried to introduce the jargon as gently as I could (by first introducing
> the term "binding" on its own before mentioning "lexical/dynamic
> binding"), but it's still a bit intimidating. On the positive side, when
> lexical binding is the default, we could remove that entire digression.
>
> There's also an argument that the example I added is in the wrong spot,
> since we haven't actually introduced the 'let' syntax yet. However, I
> personally find the example to be pretty useful since it shows off one
> of the key differences between lexical and dynamic binding, and helps
> show one of the boundaries of the 'let' form's scope. I myself tend to
> learn best by seeing examples of that sort. Fixing the order so we
> introduce the syntax first would require more extensive changes to this
> section...
Richard, could you please review these changes?
> From 12847e0d59b2de3791efa090addc0169e713e6d1 Mon Sep 17 00:00:00 2001
> From: Jim Porter <jporterbugs@gmail.com>
> Date: Wed, 25 Oct 2023 20:43:57 -0700
> Subject: [PATCH] Introduce 'let' using lexical binding in the Lisp
> Introduction
>
> * doc/lispintro/emacs-lisp-intro.texi (Prevent confusion): Rework the
> explanation to discuss how things work under lexical binding
> (including how to enable it).
> ---
> doc/lispintro/emacs-lisp-intro.texi | 67 ++++++++++++++++++++++-------
> 1 file changed, 51 insertions(+), 16 deletions(-)
>
> diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
> index fce7583fe91..e805833f979 100644
> --- a/doc/lispintro/emacs-lisp-intro.texi
> +++ b/doc/lispintro/emacs-lisp-intro.texi
> @@ -3602,24 +3602,59 @@ Prevent confusion
> @cindex @samp{variable, local}, defined
> The @code{let} special form prevents confusion. @code{let} creates a
> name for a @dfn{local variable} that overshadows any use of the same
> -name outside the @code{let} expression. This is like understanding
> -that whenever your host refers to ``the house'', he means his house, not
> -yours. (Symbols used in argument lists work the same way.
> +name outside the @code{let} expression (in computer science jargon, we
> +call this ``binding'' the variable). This is like understanding that
> +in your host's home, whenever he refers to ``the house'', he means his
> +house, not yours. (Symbols used in argument lists work the same way.
> @xref{defun, , The @code{defun} Macro}.)
>
> -Local variables created by a @code{let} expression retain their value
> -@emph{only} within the @code{let} expression itself (and within
> -expressions called within the @code{let} expression); the local
> -variables have no effect outside the @code{let} expression.
> -
> -Another way to think about @code{let} is that it is like a @code{setq}
> -that is temporary and local. The values set by @code{let} are
> -automatically undone when the @code{let} is finished. The setting
> -only affects expressions that are inside the bounds of the @code{let}
> -expression. In computer science jargon, we would say the binding of
> -a symbol is visible only in functions called in the @code{let} form;
> -in Emacs Lisp, the default scoping is dynamic, not lexical. (The
> -non-default lexical binding is not discussed in this manual.)
> +@cindex lexical binding
> +@cindex binding, lexical
> +@cindex dynamic binding
> +@cindex binding, dynamic
> +Before we begin discussing @code{let} in detail, we must first mention
> +an important note. For historical reasons, Emacs Lisp uses a form of
> +variable binding called ``dynamic binding''. However, this manual
> +will discuss the preferred form of binding, called ``lexical binding''
> +(if you have programmed in other languages before, you're likely
> +already familiar with how lexical binding behaves). In order to use
> +lexical binding, you should add something like this to the first line
> +of your Emacs Lisp file:
> +
> +@example
> +;;; -*- lexical-binding: t -*-
> +@end example
> +
> +For more information about this, @pxref{Selecting Lisp Dialect, , ,
> +elisp, The Emacs Lisp Reference Manual}.
> +
> +With that out of the way, we can get back to discussing @code{let}.
> +Another way to think about @code{let} is that it defines a place in
> +your code where the variables you named have their own local meaning.
> +Outside of the @code{let} body, they have another meaning (or they may
> +not be defined at all).
> +
> +This means that inside the @code{let} body, calling @code{setq}
> +for a variable named by the @code{let} expression will set the value
> +of the @emph{local} variable of that name. This also means that
> +outside of the @code{let} body, calling @code{setq} for a variable
> +named by the @code{let} expression will @emph{not} affect that local
> +variable.
> +
> +For example, if you call a function inside of a @code{let}
> +body, that function's body would be unable to ``see'' (or modify) the
> +value of a local variable from the @code{let} expression:
> +
> +@example
> +(setq x 1)
> +
> +(defun getx ()
> + x)
> +
> +(let ((x 2))
> + (get-x))
> + @result{} 1
> +@end example
>
> @code{let} can create more than one variable at once. Also,
> @code{let} gives each variable it creates an initial value, either a
> --
> 2.25.1
>
next prev parent reply other threads:[~2023-11-04 8:27 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-26 5:54 bug#66756: 30.0.50; [PATCH] Improve discussion of 'let' in Elisp Introduction manual Jim Porter
2023-10-26 18:30 ` Jim Porter
2023-10-29 16:38 ` Richard Stallman
2023-10-29 17:18 ` Drew Adams
2023-11-18 2:09 ` Jim Porter
2023-11-19 3:39 ` Richard Stallman
2023-11-19 5:25 ` Jim Porter
2023-11-19 5:30 ` Jim Porter
2023-11-19 8:38 ` Michael Albinus
2023-11-19 20:17 ` Jim Porter
2023-11-19 23:05 ` Jim Porter
2023-11-20 13:28 ` Michael Albinus
2023-11-23 2:57 ` Richard Stallman
2023-11-23 21:04 ` Jim Porter
2023-11-24 7:06 ` Eli Zaretskii
2023-11-24 9:01 ` Jim Porter
2023-11-24 11:41 ` Eli Zaretskii
2023-11-24 21:46 ` Jim Porter
2023-11-25 7:51 ` Eli Zaretskii
2023-11-30 21:03 ` Jim Porter
2023-12-01 8:29 ` Eli Zaretskii
2023-12-04 3:08 ` Richard Stallman
2023-12-04 3:08 ` Richard Stallman
2023-12-04 4:34 ` Jim Porter
2023-12-10 19:36 ` Jim Porter
2023-12-16 23:10 ` Stefan Kangas
2023-12-17 20:47 ` Jim Porter
2024-01-09 18:40 ` Jim Porter
2023-12-04 3:08 ` Richard Stallman
2023-11-04 8:27 ` Eli Zaretskii [this message]
2023-11-04 16:44 ` Jim Porter
2023-11-06 2:29 ` Richard Stallman
2023-11-06 2:29 ` Richard Stallman
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=83fs1l6hyw.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=66756@debbugs.gnu.org \
--cc=jporterbugs@gmail.com \
--cc=rms@gnu.org \
/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).