help-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE : insert string at point with emacs-version


From: Drew Adams
Subject: RE : insert string at point with emacs-version
Date: Tue, 1 Feb 2022 17:49:19 +0000

> 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'.

<<attachment: winmail.dat>>


reply via email to

[Prev in Thread] Current Thread [Next in Thread]