bug#25292: Ambiguity in doc string of defvar

bug#25292: Ambiguity in doc string of defvar

[Alan Mackenzie]

Hello, Emacs.

The doc string for defvar includes this bit:

    The optional argument INITVALUE is evaluated, and used to set
    SYMBOL, only if SYMBOL's value is void.

Supposing SYMBOL's value is bound.  Clearly it does not get set to
INITVALUE.  But in this case is INITVALUE evaluated (and the result
discarded) or not?  The text leaves this ambiguous.  An improvement
would be the appropriate one of the following:

    If SYMBOL's value is void, the optional argument INITVALUE is
    evaluated and used to set SYMBOL.

    INITVALUE is evaluated, and if SYMBOL's value is void, it is used to
    set SYMBOL.

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#25292: Ambiguity in doc string of defvar

[Eli Zaretskii]

> Date: Thu, 29 Dec 2016 18:18:38 +0000
> From: Alan Mackenzie <acm@muc.de>
> 
>     INITVALUE is evaluated, and if SYMBOL's value is void, it is used to
>     set SYMBOL.                                            ^^

That "it" is ambiguous.  By default, people tend to interpret "it" as
referring to the last noun before it, but that's not what you mean in
this case.

And after all that, are you sure INITVALUE is always evaluated?

bug#25292: Ambiguity in doc string of defvar

[Alan Mackenzie]

Hello, Eli.

On Thu, Dec 29, 2016 at 08:29:15PM +0200, Eli Zaretskii wrote:
> > Date: Thu, 29 Dec 2016 18:18:38 +0000
> > From: Alan Mackenzie <acm@muc.de>

> >     INITVALUE is evaluated, and if SYMBOL's value is void, it is used to
> >     set SYMBOL.                                            ^^

> That "it" is ambiguous.  By default, people tend to interpret "it" as
> referring to the last noun before it, but that's not what you mean in
> this case.

Yes, it's no better than what I was complaining about.  :-(

> And after all that, are you sure INITVALUE is always evaluated?

I've had a look at eval.c.  INITVALUE is evaluated only when it's going
to be used.

So, maybe the whole paragraph should look like this:

    If SYMBOL's value is void and the optional argument INITVALUE is
    provided, INITVALUE is evaluated and the result used to set SYMBOL.
    If SYMBOL is buffer-local, its default value is what is set;
    buffer-local values are not affected.  If INITVALUE is missing,
    SYMBOL's value is not set.
 
What do you think?

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#25292: Ambiguity in doc string of defvar

[Eli Zaretskii]

> Date: Thu, 29 Dec 2016 19:42:38 +0000
> Cc: 25292@debbugs.gnu.org
> From: Alan Mackenzie <acm@muc.de>
> 
>     If SYMBOL's value is void and the optional argument INITVALUE is
>     provided, INITVALUE is evaluated and the result used to set SYMBOL.
                                                           ^^^^^^^^^^^^^
"...to set SYMBOL's value."

>     If SYMBOL is buffer-local, its default value is what is set;
>     buffer-local values are not affected.  If INITVALUE is missing,
>     SYMBOL's value is not set.
>  
> What do you think?

Other than that, LGTM, thanks.

bug#25292: Ambiguity in doc string of defvar

[Alan Mackenzie]

Hello, Eli.

On Thu, Dec 29, 2016 at 10:35:07PM +0200, Eli Zaretskii wrote:
> > Date: Thu, 29 Dec 2016 19:42:38 +0000
> > Cc: 25292@debbugs.gnu.org
> > From: Alan Mackenzie <acm@muc.de>

> >     If SYMBOL's value is void and the optional argument INITVALUE is
> >     provided, INITVALUE is evaluated and the result used to set SYMBOL.
>                                                            ^^^^^^^^^^^^^
> "...to set SYMBOL's value."

> >     If SYMBOL is buffer-local, its default value is what is set;
> >     buffer-local values are not affected.  If INITVALUE is missing,
> >     SYMBOL's value is not set.
 
> > What do you think?

> Other than that, LGTM, thanks.

OK.  I've made that correction, and committed the amended doc string.
I'm closing the bug as fixed.

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#25292: Ambiguity in doc string of defvar

[Eli Zaretskii]

> Date: Thu, 29 Dec 2016 20:57:22 +0000
> Cc: 25292-done@debbugs.gnu.org
> From: Alan Mackenzie <acm@muc.de>
> 
> OK.  I've made that correction, and committed the amended doc string.

Thanks, but why on master?...

bug#25292: Ambiguity in doc string of defvar

[Alan Mackenzie]

Hello, Eli.

On Fri, Dec 30, 2016 at 09:46:46AM +0200, Eli Zaretskii wrote:
> > Date: Thu, 29 Dec 2016 20:57:22 +0000
> > Cc: 25292-done@debbugs.gnu.org
> > From: Alan Mackenzie <acm@muc.de>

> > OK.  I've made that correction, and committed the amended doc string.

> Thanks, but why on master?...

I think I assumed (subconsciously) that emacs-25 was deep frozen prior
to the next release.

Anyhow, I've backported the change onto emacs-25.

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#25292: Ambiguity in doc string of defvar

[Eli Zaretskii]

> Date: Fri, 30 Dec 2016 09:02:42 +0000
> Cc: 25292@debbugs.gnu.org
> From: Alan Mackenzie <acm@muc.de>
> 
> > > OK.  I've made that correction, and committed the amended doc string.
> 
> > Thanks, but why on master?...
> 
> I think I assumed (subconsciously) that emacs-25 was deep frozen prior
> to the next release.

Not for documentation changes.

> Anyhow, I've backported the change onto emacs-25.

Thanks!