From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Gabriel Newsgroups: gmane.emacs.bugs Subject: bug#49373: 28.0.50; [PATCH] Use 'remember-buffer' in remember.el doc strings Date: Sun, 04 Jul 2021 12:21:42 -0300 Message-ID: References: <835yxqipkx.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4321"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) To: 49373@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jul 04 17:26: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 1m040X-000102-Td for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 04 Jul 2021 17:26:10 +0200 Original-Received: from localhost ([::1]:33982 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m040W-0006yj-TE for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 04 Jul 2021 11:26:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44956) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m040Q-0006yX-D6 for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 11:26:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59722) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m040Q-0000hh-63 for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 11:26:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1m040P-0001fq-V4 for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 11:26:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Gabriel Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 04 Jul 2021 15:26:01 +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 X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.16254123056349 (code B ref -1); Sun, 04 Jul 2021 15:26:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 4 Jul 2021 15:25:05 +0000 Original-Received: from localhost ([127.0.0.1]:43035 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m03zU-0001eJ-Gk for submit@debbugs.gnu.org; Sun, 04 Jul 2021 11:25:04 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:48160) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1m03zP-0001dn-Fg for submit@debbugs.gnu.org; Sun, 04 Jul 2021 11:25:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44860) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m03zP-0005vk-8t for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 11:24:59 -0400 Original-Received: from mail-dm6nam12olkn2101.outbound.protection.outlook.com ([40.92.22.101]:21472 helo=NAM12-DM6-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m03zN-0008SK-9s for bug-gnu-emacs@gnu.org; Sun, 04 Jul 2021 11:24:59 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=lhhsHNEhQx/V9rWc249neg3Uh7WnQw0HESEKaQ912PoL/lp2AyI0SlaC+3qT38LJehUzifXJD6eLBytAMuTiceuLIa9mCtY97rnYeP5cXFSE28dECYB+qShEHBFf5D0qp9AlxMOI+OK8M/ZaSjZ2g+nMCR78hn9b6XsHl+qr4x4gaCCW0/05zb9xIj5/pEYeucr16GR2SsRW1bNPv953mums0VmcwMF/tjgqAPdW44ma+GSmUwBELPO7JanfNMXV37JfthaEOLx6oKfRi/1Pcn+bwopV/b67kVe1aT5ldLUWQawY+YVgWbLP9klkmbMTM2WutWb8P3MkT9y/SZv0KA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=lsnnx3dVqL3HYdxGTcdppF+gjdrkhCwXwUhHC9k1TLE=; b=Xo1+dHUFV7GKSH4Dxlj28gOkOfUqLOtAXrJBtszDYZrupaxEpk/PA4nVjleELAfg6X8sT0VPBC0QmiCZ6qnyFUB3GkNz6RlqdLFAFUQocCkAVwCu6CFdRZ2WV8S+XSYWYY5lRLs29BwzIDXjBRcNEOXdFkb/SZ3aHjDnlzw7Y0GDJBpU6mHEh+hgJ6W1VgOJTNCeWKanFpfpfZSA5Bx5CFR/+bsRrHP7QZDFxBtnnIUzJVz1flx/WEBfHVa3YDUgZhJPKa+vtiTubK55poOJ8dDNvWU9FN8XmYdTUZJIatds/Gz/bvYDEmBD3rIqRAsxMGTgOO/46N6WnQ/I7SFyRA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=hotmail.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=lsnnx3dVqL3HYdxGTcdppF+gjdrkhCwXwUhHC9k1TLE=; b=Y1yKOSZpiV8NhsRqSCJowyTbgtl4borbvTABVN6c4xXSkLrnwsqnYsCKXGnRZG8fu+uD89F3QhsSA9aLiCSkTgulkZCuCWspJd7s0lGoJqucOx7aCWlCxWOUnY9TpEr15ptQNMtHT+Sep6Yv/RMZcDwgdM8Q1JQUZFc/QBrH5hY0kYuEN/TWUHSVZwGTwjQRf9JcG/B0tdhsfqZtgEHNaO/0I8iIl5LSYG+NHf7utE7xXzMy8c2PvqUDuCO9ucEBfeFlXCz66UGJn+EDiRTJuYifkUuLYljr26MlvehXsrEuStz9cVPhWx3X8gGYgnVrDFQ/RPU+1p6kHfYCmtGI7Q== Original-Received: from MW2NAM12FT008.eop-nam12.prod.protection.outlook.com (2a01:111:e400:fc65::44) by MW2NAM12HT065.eop-nam12.prod.protection.outlook.com (2a01:111:e400:fc65::133) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4308.8; Sun, 4 Jul 2021 15:24:55 +0000 Original-Received: from CH2PR01MB5879.prod.exchangelabs.com (2a01:111:e400:fc65::42) by MW2NAM12FT008.mail.protection.outlook.com (2a01:111:e400:fc65::75) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4308.8 via Frontend Transport; Sun, 4 Jul 2021 15:24:55 +0000 X-IncomingTopHeaderMarker: OriginalChecksum:994CCD84C1DA1AD6DB059F31C007D8A7533A405F4CDB401A49277EEB58AE4246; UpperCasedChecksum:C4FE7FC39104D690F1AE0E6C47788424B4C1332F79A81EE875F5F4C167CCC0CA; SizeAsReceived:7510; Count:45 Original-Received: from CH2PR01MB5879.prod.exchangelabs.com ([fe80::5c64:1750:c3c7:c182]) by CH2PR01MB5879.prod.exchangelabs.com ([fe80::5c64:1750:c3c7:c182%2]) with mapi id 15.20.4287.033; Sun, 4 Jul 2021 15:24:55 +0000 In-Reply-To: <835yxqipkx.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 04 Jul 2021 09:02:38 +0300") X-TMN: [oNtmnxHC4ROSnX65sbGx4mEPGsTRyOzzLE+oPAtIaWuKh0BAeFku/f7k+/rrd+QQ] X-ClientProxiedBy: CP2P15201CA0025.LAMP152.PROD.OUTLOOK.COM (2603:10d6:102:1c::11) To CH2PR01MB5879.prod.exchangelabs.com (2603:10b6:610:3c::12) X-Microsoft-Original-Message-ID: <87pmvy5cl5.fsf@hotmail.com> X-MS-Exchange-MessageSentRepresentingType: 1 Original-Received: from desktop (2804:431:c7f2:3723:2e97:3346:1d59:b110) by CP2P15201CA0025.LAMP152.PROD.OUTLOOK.COM (2603:10d6:102:1c::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4287.22 via Frontend Transport; Sun, 4 Jul 2021 15:24:54 +0000 X-MS-PublicTrafficType: Email X-IncomingHeaderCount: 45 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-Correlation-Id: b21de0ee-2f33-4027-1db5-08d93effe02c X-MS-TrafficTypeDiagnostic: MW2NAM12HT065: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: UsrbNfN71st10nkfFIZW8hbAneH2QhefqJDCPTzVodLesleWw+pA3R5xBkKqt/D1kzKKglb4ah2/r2nvAQXvS2geqFVJW7SY+CzhcFS75wgigJlYmjCA5yBegk2BMTCN1LaAs7FFe9seBcExe7M3VveES8Armknpfm1mM2smflmFOLexsHh91vZ6YKm6UrFiYhJhl5BcHePUOMxySQqKBarZS0qV7CaXsBDaoENZgEFTv3ZEUTKF11NHzhWt28kfOgme4GhJxOHuzWSVPQlFl9SBzq7sxU0ToK5FbBTUlATV6asVwVUop+GzREugK7L8N4hbXOoSAqMHQn3bQh0jK9Jaochs4DFCH8LiZ5ixJMZGpIFw8Qm3+bVXI+7sMLI0G78sHFmthVOq1pA3PcuVdF6bfxfvaJ8UrLh6ng3W+qQe/6EXa4N67uvb8b66mldP X-MS-Exchange-AntiSpam-MessageData: 49L6WT2KDP51Kb+HGqIsB3yDzM0KwUVaX/Ak7jNUZtxCdVCc4+CJMV1JiyJ+igOASJyE0NIxRRPmzeN3Ox5tpQLcW+0fn8DNxJFIi+NpYeBRX9lEm/LHQWyx0DbrnohoDiu40dCa2tZOFeB1GpgWhc+2Vi5EOxLfgxzMUDJUNuU7iWkDOJ/x67E208XR/zutRwqeMiy/R5VSzUoToWZDlA== X-OriginatorOrg: hotmail.com X-MS-Exchange-CrossTenant-Network-Message-Id: b21de0ee-2f33-4027-1db5-08d93effe02c X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Jul 2021 15:24:55.2433 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-AuthSource: MW2NAM12FT008.eop-nam12.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: Internet X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW2NAM12HT065 Received-SPF: pass client-ip=40.92.22.101; envelope-from=gabriel376@hotmail.com; helo=NAM12-DM6-obe.outbound.protection.outlook.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 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_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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:209410 Archived-At: Eli Zaretskii writes: >> From: Gabriel >> Date: Sun, 04 Jul 2021 02:15:14 -0300 >> >> This patch replaces the hard coded '*Remember*' string with >> 'remember-buffer' in all doc strings occurrences in remember.el. > > 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? 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.". If the maintainers decide to not change any defvar to defcustom, feel free to close this bug report. Thank you, Gabriel