all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* RE : insert string at point with emacs-version
@ 2022-02-01 17:49 Drew Adams
  0 siblings, 0 replies; only message in thread
From: Drew Adams @ 2022-02-01 17:49 UTC (permalink / raw)
  To: goncholden, 'Help-Gnu-Emacs (help-gnu-emacs@gnu.org)'

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

> 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 #2: winmail.dat --]
[-- Type: application/ms-tnef, Size: 13383 bytes --]

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2022-02-01 17:49 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-02-01 17:49 RE : insert string at point with emacs-version Drew Adams

Code repositories for project(s) associated with this external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.