bug#53720: closed (Documentation for emacs-version)

[GNU bug Tracking System]

Your message dated Wed, 02 Feb 2022 19:40:08 +0200
with message-id <83v8xx5frb.fsf@gnu.org>
and subject line Re: bug#53720: Documentation for emacs-version
has caused the debbugs.gnu.org bug report #53720,
regarding Documentation for emacs-version
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
53720: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=53720
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> Documentation for emacs-version
>
>
>
>
> Date: 
>
> Wed, 02 Feb 2022 10:03:29 +0000
>
>
>
>
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
>
> On Tuesday, February 1st, 2022 at 5:49 PM, Drew Adams <drew.adams@oracle.com> 
> wrote:
>
> > I am looking up documentation for emacs-version. But cannot understand the
> >
> > meaning of
> >
> > If optional argument HERE is non-nil, insert string at point.
> >
> > Doc:
> >
> > (emacs-version &optional HERE)
> >
> > Probably introduced at or before Emacs version 19.20.
> >
> > Return string describing the version of Emacs that is running.
> >
> > If optional argument HERE is non-nil, insert string at point.
>
> This is the doc string for Emacs 27.2 (the latest release):
>
> Return string describing the version of Emacs that is running.
>
> If optional argument HERE is non-nil, insert string at point.
>
> Don’t use this function in programs to choose actions according
>
> to the system configuration; look at ‘system-configuration’ instead.
>
> But it's still a poor doc string. It should, first
>
> of all, describe the interactive use. It should say:
>
> With a prefix argument, insert string at point.
>
> ^^^^^^^^^^^^^^^^^^^^^^
>
> Only after that interactive description should it
>
> give the Emacs-Lisp description of argument HERE:
>
> When called from Lisp, optional argument HERE
>
> corresponds to the prefix argument.
>
> Consider filing a (doc) bug report for this:
>
> `M-x report-emacs-bug'.
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#53720: Documentation for emacs-version
>
>
>
>
> Date: 
>
> Wed, 02 Feb 2022 19:40:08 +0200
>
>
>
>
> > Date: Wed, 02 Feb 2022 10:03:29 +0000
> > From:  goncholden via "Bug reports for GNU Emacs,
> >  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> > 
> > > (emacs-version &optional HERE)
> > > Probably introduced at or before Emacs version 19.20.
> > > Return string describing the version of Emacs that is running.
> > > If optional argument HERE is non-nil, insert string at point.
> > 
> > This is the doc string for Emacs 27.2 (the latest release):
> > 
> > Return string describing the version of Emacs that is running.
> > If optional argument HERE is non-nil, insert string at point.
> > Don’t use this function in programs to choose actions according
> > to the system configuration; look at ‘system-configuration’ instead.
> > But it's still a poor doc string. It should, first
> > of all, describe the interactive use. It should say:
> > With a prefix argument, insert string at point.
> > ^^^^^^^^^^^^^^^^^^^^^^
> > Only after that interactive description should it
> > give the Emacs-Lisp description of argument HERE:
> > When called from Lisp, optional argument HERE
> > corresponds to the prefix argument.
> > Consider filing a (doc) bug report for this:
> > `M-x report-emacs-bug'.
>
> Thanks, I fixed the wording of the doc string.
>
>
> --- End Message ---