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#49373: 28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings Date: Sun, 04 Jul 2021 19:37:34 +0300 Message-ID: <83pmvyghm9.fsf@gnu.org> References: <835yxqipkx.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11774"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 49373@debbugs.gnu.org To: Gabriel , Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jul 04 18:38:11 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 1m058F-0002v3-BQ for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 04 Jul 2021 18:38:11 +0200 Original-Received: from localhost ([::1]:52820 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m058E-0007W8-AH for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 04 Jul 2021 12:38:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53768) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m0586-0007Ul-Fu for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 12:38:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59858) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m0586-0004gJ-7m for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 12:38:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1m0586-0003b3-3I for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 12:38:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 04 Jul 2021 16:38:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 49373 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 49373-submit@debbugs.gnu.org id=B49373.162541665813792 (code B ref 49373); Sun, 04 Jul 2021 16:38:02 +0000 Original-Received: (at 49373) by debbugs.gnu.org; 4 Jul 2021 16:37:38 +0000 Original-Received: from localhost ([127.0.0.1]:43171 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m057h-0003aO-VG for submit@debbugs.gnu.org; Sun, 04 Jul 2021 12:37:38 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:55992) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m057g-0003aC-GV for 49373@debbugs.gnu.org; Sun, 04 Jul 2021 12:37:36 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:44504) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m057a-0004NI-UQ; Sun, 04 Jul 2021 12:37:30 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1305 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 1m057a-0000rO-Hb; Sun, 04 Jul 2021 12:37:30 -0400 In-Reply-To: (message from Gabriel on Sun, 04 Jul 2021 12:21:42 -0300) 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:209415 Archived-At: > From: Gabriel > Date: Sun, 04 Jul 2021 12:21:42 -0300 > > > remember-buffer is an internal variable, so exposing it in the doc > > strings of public functions, let alone commands, is not necessarily > > TRT? > > Hi Eli, > > Good catch! I didn't notice that 'remember-buffer' is a defvar. Indeed > it does not make sense to refer to an internal variable in the doc > string of public functions. > > Perhaps the 'remember-buffer' could be changed to a defcustom? I won't object, if that would help in some use cases. Lars, WDYT? > By the way, the 'remember-initial-contents' seems to be another > candidate for a defcustom, but I am not sure if I really understood its > use case. It's an internal variable, with a default value of nil, that > is not set anywhere and reset to nil on every call of 'remember'. If we > set a value and remove the reset inside 'remember', it works as > described by the name and by the doc string: "Initial contents to place > into *Remember* buffer.". Same response here: would that be useful enough?