From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#53720: Documentation for emacs-version Date: Wed, 02 Feb 2022 19:40:08 +0200 Message-ID: <83v8xx5frb.fsf@gnu.org> References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="5106"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 53720-done@debbugs.gnu.org To: goncholden Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Feb 02 19:27:08 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 1nFKLU-00017r-2t for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 02 Feb 2022 19:27:08 +0100 Original-Received: from localhost ([::1]:48402 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nFKLS-0001c0-SM for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 02 Feb 2022 13:27:06 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:57318) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFJe7-0001xL-3l for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 12:42:19 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59481) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nFJdp-0001ha-SE for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 12:42:18 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nFJdp-0003On-Me for bug-gnu-emacs@gnu.org; Wed, 02 Feb 2022 12:42:01 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Wed, 02 Feb 2022 17:42:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 53720 X-GNU-PR-Package: emacs Mail-Followup-To: 53720@debbugs.gnu.org, eliz@gnu.org, goncholden@protonmail.com Original-Received: via spool by 53720-done@debbugs.gnu.org id=D53720.164382371413043 (code D ref 53720); Wed, 02 Feb 2022 17:42:01 +0000 Original-Received: (at 53720-done) by debbugs.gnu.org; 2 Feb 2022 17:41:54 +0000 Original-Received: from localhost ([127.0.0.1]:53377 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nFJdh-0003OJ-Rn for submit@debbugs.gnu.org; Wed, 02 Feb 2022 12:41:54 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:50532) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nFJdc-0003O0-DV for 53720-done@debbugs.gnu.org; Wed, 02 Feb 2022 12:41:52 -0500 Original-Received: from [2001:470:142:3::e] (port=40066 helo=fencepost.gnu.org) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFJdT-0001et-J6; Wed, 02 Feb 2022 12:41:41 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=3OS8/vXYHZECKlmajzLZ1Wr1k3U/kn4QlpWpBOAZYds=; b=Vdg9rM/V1qyrXsVje8VU d3KtI8uaonwzI3UCdPyALhuIqslrUW16lJYr4jJvCbSbAbJZ3OhLdv2tcj1Xv6GBtpHCaLD6m4qmW LGQ+Rn93e6n6rO2j2Q5sjckdfgc9DN042JNgHftl6jP55Di7dUmJv222v5OGYKKV4jk6t5aBL793O iDpBmmfVyop2oRy53+19ESnSBoYm+55kcFAKjxC9j9pfDiMiLnTE2s0yUiCMER4QcoSSG3My46vWi s4P5JlggckzCv08SbVVG2qzxymKaFDILBTPBEG2ql+M661sQib95i66vw1vjKNDPj16aL4iULJODq ljnOLG7WVsXmTA==; Original-Received: from [87.69.77.57] (port=2746 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nFJby-0007e7-Ah; Wed, 02 Feb 2022 12:41:16 -0500 In-Reply-To: (bug-gnu-emacs@gnu.org) 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" Xref: news.gmane.io gmane.emacs.bugs:225800 Archived-At: > Date: Wed, 02 Feb 2022 10:03:29 +0000 > From: goncholden via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > > (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.