From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: goncholden via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#53720: Documentation for emacs-version Date: Wed, 02 Feb 2022 10:03:29 +0000 Message-ID: Reply-To: goncholden Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8807"; mail-complaints-to="usenet@ciao.gmane.io" To: drew.adams@oracle.com, 53720@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Feb 02 13:21:36 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nFEdk-00025I-3K for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 02 Feb 2022 13:21:36 +0100 Original-Received: from localhost ([::1]:36034 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nFEdg-0000wy-Pl for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 02 Feb 2022 07:21:34 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:49220) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFEbG-0000tZ-66 for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 07:19:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57840) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nFEbF-0003JU-R7 for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 07:19:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nFEbF-0003vd-O3 for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 07:19:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: goncholden Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 02 Feb 2022 12:19:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 53720 X-GNU-PR-Package: emacs X-Debbugs-Original-To: Drew Adams , "bug-gnu-emacs@gnu.org" Original-Received: via spool by submit@debbugs.gnu.org id=B.164380433015079 (code B ref -1); Wed, 02 Feb 2022 12:19:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 2 Feb 2022 12:18:50 +0000 Original-Received: from localhost ([127.0.0.1]:51737 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nFEb2-0003v6-Nv for submit@debbugs.gnu.org; Wed, 02 Feb 2022 07:18:49 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:48366) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nFCUX-0008M3-4O for submit@debbugs.gnu.org; Wed, 02 Feb 2022 05:04:00 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:44146) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFCUW-0003mL-Ue for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 05:03:56 -0500 Original-Received: from mail-40130.protonmail.ch ([185.70.40.130]:39654) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFCUS-0008G4-95 for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 05:03:56 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail2; t=1643796211; bh=tnri5uie2eJoNEpa9/XnkPzprU6CzzED48W6gzyBsKM=; h=Date:To:From:Reply-To:Subject:Message-ID:From:To:Cc; b=m4xauhMo9fOcPv2qybZC6zuyaXgUr2YbrJO8h5EBKaqQBMUhhv5SPV0LBHKWbalta dPKm40TfcLv0f/q1pkQREMuGBgvZvRahHq8PalHLk4JMJ5E0GngMESPDPED4lZcMEB MLXVM6uNPkOi4PC2StyljwCfvs+ecOTtket1qCfNefWlKC8JQ90hOD6NCnVpDbfUem 80Adi4+jJd3S5Sk3tTQHN+dTAi4wJJQNeNl6k3U+re0Z1dl+zKOdDheHP579cKy4PC EdYN+arYwGfoT498rsHFPDjjT8AQwpHiSO6G1/dec1UJqhr4asI0vEASgkHB6XSNfu g89R8ryI7v/WA== Received-SPF: pass client-ip=185.70.40.130; envelope-from=goncholden@protonmail.com; helo=mail-40130.protonmail.ch X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Wed, 02 Feb 2022 07:18:47 -0500 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" X-ACL-Warn: , goncholden Xref: news.gmane.io gmane.emacs.bugs:225790 Archived-At: =E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90 Original Me= ssage =E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90=E2=80=90 On Tuesday, February 1st, 2022 at 5:49 PM, Drew Adams wrote: > I am looking up documentation for emacs-version. But cannot understand th= e > > 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=E2=80=99t use this function in programs to choose actions according to the system configuration; look at =E2=80=98system-configuration=E2=80= =99 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'.