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#48730: 28.0.50; [PATCH] Add a documentation group section about buffer overlays Date: Sat, 29 May 2021 17:54:27 +0300 Message-ID: <83fsy5615o.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="17864"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 48730@debbugs.gnu.org To: Daniel =?UTF-8?Q?Mart=C3=ADn?= Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat May 29 16:55:10 2021 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 1ln0Mn-0004QM-Vo for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 29 May 2021 16:55:09 +0200 Original-Received: from localhost ([::1]:36040 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ln0Mm-0001Aw-6P for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 29 May 2021 10:55:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56232) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ln0Mg-0001Ao-8l for bug-gnu-emacs@gnu.org; Sat, 29 May 2021 10:55:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:46001) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ln0Mg-0004gL-0y for bug-gnu-emacs@gnu.org; Sat, 29 May 2021 10:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ln0Mf-0006gD-Vk for bug-gnu-emacs@gnu.org; Sat, 29 May 2021 10:55:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 29 May 2021 14:55:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48730 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 48730-submit@debbugs.gnu.org id=B48730.162230006625591 (code B ref 48730); Sat, 29 May 2021 14:55:01 +0000 Original-Received: (at 48730) by debbugs.gnu.org; 29 May 2021 14:54:26 +0000 Original-Received: from localhost ([127.0.0.1]:57539 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ln0M6-0006eh-GM for submit@debbugs.gnu.org; Sat, 29 May 2021 10:54:26 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:34232) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ln0M3-0006eO-If for 48730@debbugs.gnu.org; Sat, 29 May 2021 10:54:25 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:45104) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ln0Ly-0004Ed-6q; Sat, 29 May 2021 10:54:18 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2977 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 1ln0Lx-0007Cb-On; Sat, 29 May 2021 10:54:18 -0400 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:207538 Archived-At: > Date: Sat, 29 May 2021 16:29:16 +0200 > From: Daniel Martín via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > - Fixed a typo in the manual and improved a bit some explanations and > docstrings that were not very clear to me when I read them. Thanks. Not everything in this part is correct: > @example > :no-eval* (buffer-string) > @end example > > -will result in: > +will be printed as: Not sure why this change is needed, they are equivalent, and your variant uses passive tense, which we try to avoid. > +For instance: > > @example > :no-eval (looking-at "f[0-9]") > :eg-result t > @end example > > +will be printed as: You need @noindent before the "will be printed" line. > -By default, the function's actual argument list is shown. If > -@code{:args} is present, they are used instead. > +By default, the function's actual argument list is shown. If the > +@code{:args} keyword is present, its value is shown instead. I think the original reads better, FWIW.