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#47117: 28.0.50; [PATCH] Update docstring of 'tab-line-tabs-function' Date: Sat, 13 Mar 2021 19:10:45 -0300 Message-ID: References: <875z1uag84.fsf@mail.linkov.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1098"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) To: 47117@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 13 23:12: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 1lLCUU-0000Bh-Ci for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 13 Mar 2021 23:12:10 +0100 Original-Received: from localhost ([::1]:55074 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lLCUT-0002pI-8R for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 13 Mar 2021 17:12:09 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47634) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lLCUM-0002ni-KD for bug-gnu-emacs@gnu.org; Sat, 13 Mar 2021 17:12:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:49324) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lLCUM-0005eX-CO for bug-gnu-emacs@gnu.org; Sat, 13 Mar 2021 17:12:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lLCUM-0001Q6-7b for bug-gnu-emacs@gnu.org; Sat, 13 Mar 2021 17:12:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Gabriel Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 Mar 2021 22:12:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 47117 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.16156734725399 (code B ref -1); Sat, 13 Mar 2021 22:12:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 13 Mar 2021 22:11:12 +0000 Original-Received: from localhost ([127.0.0.1]:60870 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lLCTV-0001Oz-C4 for submit@debbugs.gnu.org; Sat, 13 Mar 2021 17:11:11 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:56666) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lLCTQ-0001Op-Ls for submit@debbugs.gnu.org; Sat, 13 Mar 2021 17:11:08 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47498) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lLCTQ-0002eT-92 for bug-gnu-emacs@gnu.org; Sat, 13 Mar 2021 17:11:04 -0500 Original-Received: from mail-bn8nam11olkn2085.outbound.protection.outlook.com ([40.92.20.85]:20332 helo=NAM11-BN8-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 1lLCTM-0005A3-T5 for bug-gnu-emacs@gnu.org; Sat, 13 Mar 2021 17:11:03 -0500 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LVbyzjnhZ5vTU/PWcmyyeTMfuv5s26fjUvKYZhZ1IIStfGds4Fv9IAAzaNWZd5SiCLK+tsFxhdLAeuudc7yg/yi11S97tUDTCopyThkOnngdE4yQy5iosxadTsOKwkXh8ZNyN2ukAqNt/Fclv5I2l/lQmkmoSsDKv/inLqGaWdwe1/IaEP2ZvqC08L5zk8C3G9gVjqb6kg8lgxt65QIhOW9NXHIWeOVEIjs+f3tQxGeKxyQv2JVtcJfwrMETSYCtcSJjTA7ECK/iv18ZFR90i6CQkdblQlWDbx4HKyDK9HE1agj4Gr/Wd2ViwZ1cv6PuN+IZ2G3lYpzU5MhAe6u/EQ== 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=8VHnI/6SBztH2rB1MKTyC+qlTheLJ5u7/vDwylr4Ags=; b=FsarF7EXZC9NkEllsWDJ1a45kkyApwUdunqNU6Xs+41/xS84zn9xmgV1Pf9M1gIbq7ly8DkfrrmzXxr/OrJzQeoYJ1hSLSL117oBhZGS3r/ONdHRW0KXnae7BWp4d9FHV+Fp2imJ++oN3js3RzMG02+lUBt4CivRan7E7AxbNzyDPFjKOvsS/DPBuVuVLQ2bFRZkb5KRBXGRx/TH76GwV4RVLU8SJXLxyTTZmEpaAKOe2rwZPaOUkdmS52bg1NMOpEVpQU3MtsoUrnoPSLxUixTuBj2AMpIDYmoNlOJQqYKIQ/ACTAU71FFxB1JRveckC9PF+8w+bxDbM5B0E/RRaQ== 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=8VHnI/6SBztH2rB1MKTyC+qlTheLJ5u7/vDwylr4Ags=; b=el7IYP7UbKIqrzG5qe0vMA02amhRh314MWT0tS9C7iGSejGL0quzkHgjYWebzGY10gECybMx0reMsZ8huFwjGnmnTfmX3uQ1cO3C0NMNXGwwLkgxIIx2oCB+w5Ef4/1LadS/raiKGo7Z2XsOuLOrfffuXjQp1303BXnoxsMOWmA98u5OwxabZdjSTB7et3sx2Mk+Ig3KQZoFEY0yAFYiAd/1jMFGTOLFfIKrg5ECZmG2oxVBNhhKSOG3EB+8XTTBs1lHkFrWbXXPV9bTvimwAb9rt5RxoDjrtkHH+BuEHKC1gyDeSwimh6im7KyTC2q/ylUq2IFmGbQy8RARHpmpsQ== Original-Received: from BN8NAM11FT014.eop-nam11.prod.protection.outlook.com (2a01:111:e400:fc4b::4d) by BN8NAM11HT154.eop-nam11.prod.protection.outlook.com (2a01:111:e400:fc4b::116) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3933.31; Sat, 13 Mar 2021 22:10:59 +0000 Original-Received: from CH2PR01MB5879.prod.exchangelabs.com (2a01:111:e400:fc4b::46) by BN8NAM11FT014.mail.protection.outlook.com (2a01:111:e400:fc4b::398) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3933.31 via Frontend Transport; Sat, 13 Mar 2021 22:10:58 +0000 X-IncomingTopHeaderMarker: OriginalChecksum:8B4D8B211AC1D69C5E39A72E807F3D427926925010EE19B40DF8122A9F884271; UpperCasedChecksum:C1318A2898582EBC8EB1BDAA3DE15625DF934F9CCA344E9DE2DBC90577DFC1C4; SizeAsReceived:7548; Count:45 Original-Received: from CH2PR01MB5879.prod.exchangelabs.com ([fe80::592f:9a58:d8cd:d9c9]) by CH2PR01MB5879.prod.exchangelabs.com ([fe80::592f:9a58:d8cd:d9c9%7]) with mapi id 15.20.3912.031; Sat, 13 Mar 2021 22:10:58 +0000 In-Reply-To: <875z1uag84.fsf@mail.linkov.net> (Juri Linkov's message of "Sat, 13 Mar 2021 23:36:27 +0200") X-TMN: [qEFPvn08bK94zsBn93GpE+Y+6nxHmPe3bvESB+G/3yQE0GqeSMqpITHUH9u/jljS] X-ClientProxiedBy: CP2P15201CA0011.LAMP152.PROD.OUTLOOK.COM (2603:10d6:102:1a::21) To CH2PR01MB5879.prod.exchangelabs.com (2603:10b6:610:3c::12) X-Microsoft-Original-Message-ID: <87r1kipuvu.fsf@hotmail.com> X-MS-Exchange-MessageSentRepresentingType: 1 Original-Received: from precision5540 (2804:431:c7f2:d29a:25d8:42fc:c5b0:f20) by CP2P15201CA0011.LAMP152.PROD.OUTLOOK.COM (2603:10d6:102:1a::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3933.31 via Frontend Transport; Sat, 13 Mar 2021 22:10:53 +0000 X-MS-PublicTrafficType: Email X-IncomingHeaderCount: 45 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-Correlation-Id: 747696bb-e9ec-4ec9-9ff9-08d8e66cde78 X-MS-TrafficTypeDiagnostic: BN8NAM11HT154: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: X9JRepl6PUjVQoR0wdLApNMwu1nyHJTc57LPmXJVcG6WxrEH1+jjp/j3mk48eL0LTH192bhOh/c6zAmSHq88jtw4jP4bRTbfoqH1p3fW2KPVyQ8nKLgMb/h3+H8cPMrhd8xYEhkFUU96QskbUk2MTBrJlVZ75qMPKUF3e4z/fDsrGrlTz9EmeqmzqrZqHF+BA+YMHb21YEXWP6y3BNU40+XBkke3APXf4iNs9zB6+61VGz6Lb8NCxx/A2dAW7QAmxorze3IBttAfJ4RRn+OySW8w4RbsqDTybWVMmkHG0u49Kz/UN1g4ck1Npn+S1qTycrHsNWTGdoafiAQNo8I7XV7a8h1t2v33rBYMCPuKXEjsI+0FXfgZQApKFycFu2UkRmGKM/BngOv1687MdfigYw== X-MS-Exchange-AntiSpam-MessageData: Bl/IhyIW/rAqHnTvrl/lgqa4N9a3PaCMmiN1Pz9DYBi1KoTFPBNQj0wnz8HIZODQuvNNI17ZawBRqFt4+2tlgWYAHyQnnXyAr4dNR1JlixIS2RqrmyTXjLIrzvmdO/ck3GKCPNbb7AuV7iMmJligIFDZj/8n1F7WDZoSkxOchdXGtz43II+2UmqLMRjSdJqnIfutRHRLj+QLbKZqFAu22Q== X-OriginatorOrg: hotmail.com X-MS-Exchange-CrossTenant-Network-Message-Id: 747696bb-e9ec-4ec9-9ff9-08d8e66cde78 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Mar 2021 22:10:58.8648 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-AuthSource: BN8NAM11FT014.eop-nam11.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: BN8NAM11HT154 Received-SPF: pass client-ip=40.92.20.85; envelope-from=gabriel376@hotmail.com; helo=NAM11-BN8-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:202316 Archived-At: --=-=-= Content-Type: text/plain Juri Linkov writes: >> The user option 'tab-line-tabs-function' on tab-line.el does not mention >> the possible value of 'tab-line-tabs-buffer-groups', which can difficult >> the discoverability of this feature for users. This patch update its >> docstring to mention the missing option, and adds a docstring to the >> function of same name. Feel free to modify the proposed patch for an >> improved and clearer docstring version. > > Thanks for your patches. There is only a very small problem: > >> (defun tab-line-tabs-buffer-groups () >> + "Return a list of buffers grouped either >> +by `tab-line-tabs-buffer-group-function', when set, >> +or by `tab-line-tabs-buffer-groups'." > > The first line of the docstring should be a complete sentence, > as described in (info "(elisp) Function Documentation") Here is an updated patch. I used 'tab-line-tabs-window-buffers' and 'tab-line-switch-cycling' as a reference. I appreciate your help, I am still learning the basic stuff. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-tab-line.el-Update-docstring-of-tab-line-tabs-f.patch >From e32da7c2be28e03881d9d1d7fba0bec53d4f0c86 Mon Sep 17 00:00:00 2001 From: Gabriel do Nascimento Ribeiro Date: Sat, 13 Mar 2021 19:04:55 -0300 Subject: [PATCH] lisp/tab-line.el: Update docstring of 'tab-line-tabs-function' (tab-line-tabs-function): Mention'tab-line-tabs-buffer-groups' in the docstring. (tab-line-tabs-buffer-groups): Add docstring. --- lisp/tab-line.el | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/lisp/tab-line.el b/lisp/tab-line.el index 903862a3e8..76c04521d5 100644 --- a/lisp/tab-line.el +++ b/lisp/tab-line.el @@ -294,7 +294,10 @@ tab-line-tabs-function By default, use function `tab-line-tabs-window-buffers' that returns a list of buffers associated with the selected window. When `tab-line-tabs-mode-buffers', return a list of buffers -with the same major mode as the current buffer." +with the same major mode as the current buffer. +When `tab-line-tabs-buffer-groups', return a list of buffers +grouped either by `tab-line-tabs-buffer-group-function', when set, +or by `tab-line-tabs-buffer-groups'." :type '(choice (const :tag "Window buffers" tab-line-tabs-window-buffers) (const :tag "Same mode buffers" @@ -356,6 +359,11 @@ tab-line-tabs-buffer-group-name mode)))) (defun tab-line-tabs-buffer-groups () + "Return a list of tabs that should be displayed in the tab line. +By default return a list of buffers grouped by major mode, +according to `tab-line-tabs-buffer-groups'. +If non nil, `tab-line-tabs-buffer-group-function' is used to +generate the group name." (if (window-parameter nil 'tab-line-groups) (let* ((buffers (funcall tab-line-tabs-buffer-list-function)) (groups -- 2.27.0 --=-=-=--